Teliax

Teliax ROC API

Resp Org Change workflow management

GitHub OpenAPI

Operations 20

PUT /v1/roc/projects/{projectId}/tfns/remove Remove TFNs from open ROC transaction #
PUT /v1/roc/projects/{projectId}/cancel Cancel ROC #
PUT /v1/roc/inbound/projects/{projectId}/process Process inbound ROC (approve/deny per TFN) #
PUT /v1/roc/inbound/projects/{projectId}/checkout Checkout inbound ROC for processing #
PUT /v1/roc/inbound/projects/{projectId}/checkin Checkin inbound ROC #
POST /v1/roc/webhook Somos ROC webhook receiver #
POST /v1/roc/sync Sync ROC requests from Somos search #
GET /v1/roc/projects List ROC projects #
POST /v1/roc/projects Create ROC project #
POST /v1/roc/projects/{projectId}/submit Submit ROC to Somos #
POST /v1/roc/projects/{projectId}/refresh Refresh ROC status from Somos #
POST /v1/roc/projects/{projectId}/loa/upload Upload LOA file #
POST /v1/roc/projects/{projectId}/loa/generate Generate LOA from Somos #
POST /v1/roc/projects/{projectId}/escalate-hdi Escalate to Somos Help Desk #
POST /v1/roc/projects/{projectId}/documents/upload Upload additional document #
GET /v1/roc/projects/{projectId} Get ROC project details #
GET /v1/roc/projects/{projectId}/documents Get documents for ROC project #
GET /v1/roc/projects/{projectId}/documents/{documentId}/download Download document #
GET /v1/roc/projects/{projectId}/details Get per-TFN details for ROC project #
GET /v1/roc/projects/{projectId}/audit Get audit log for ROC project #

Documentation

📖
Documentation
https://telique.ringer.tel/docs
📖
Documentation
https://tniq.ringer.tel/docs
📖
Documentation
https://warp.ringer.tel/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/openapi/teliax-roc-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-identity-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-query-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-cpr-dump-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-dno-lookup-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-complex-query-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-tandem-query-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-port-project-detail-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-port-project-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-port-project-detail-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-soa-query-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-toll-free-ptr-operation-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-auto-activation-settings-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-github-com-ringer-warp-api-gateway-internal-models-trunk-group-with-ips-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-github-com-ringer-warp-api-gateway-internal-models-assignment-with-usages-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-internal-handlers-trunk-update-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-github-com-ringer-warp-api-gateway-internal-models-trunk-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-github-com-ringer-warp-api-gateway-internal-models-assignment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/teliax/refs/heads/main/json-schema/teliax-internal-handlers-bulk-assign-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/teliax:teliax-roc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

teliax-roc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Teliax ROC API
  version: v1
  contact:
    name: Ringer API Support
    url: https://ringer.tel
    email: api-support@ringer.tel
  description: 'Operations tagged ROC across 2 of this provider''s published API definitions: teliax-tniq-openapi.json, teliax-tniq-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.tniq.ringer.tel
  description: Production
- url: https://tniq-api.ringer.tel
  description: Production (legacy alias)
- url: https://staging-api.ringer.tel
  description: Staging
tags:
- name: ROC
  description: Resp Org Change workflow management
paths:
  /v1/roc/projects/{projectId}/tfns/remove:
    put:
      tags:
      - ROC
      summary: Remove TFNs from open ROC transaction
      operationId: removeTfns
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/cancel:
    put:
      tags:
      - ROC
      summary: Cancel ROC
      operationId: cancelRoc
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/inbound/projects/{projectId}/process:
    put:
      tags:
      - ROC
      summary: Process inbound ROC (approve/deny per TFN)
      operationId: processInboundRoc
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RocProcessRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/inbound/projects/{projectId}/checkout:
    put:
      tags:
      - ROC
      summary: Checkout inbound ROC for processing
      operationId: checkoutInboundRoc
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/inbound/projects/{projectId}/checkin:
    put:
      tags:
      - ROC
      summary: Checkin inbound ROC
      operationId: checkinInboundRoc
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/webhook:
    post:
      tags:
      - ROC
      summary: Somos ROC webhook receiver
      description: Receives push notifications from Somos when ROC status changes. No JWT required.
      operationId: handleWebhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/sync:
    post:
      tags:
      - ROC
      summary: Sync ROC requests from Somos search
      operationId: syncFromSomos
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RocSyncRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects:
    get:
      tags:
      - ROC
      summary: List ROC projects
      operationId: listProjects
      parameters:
      - name: customerId
        in: query
        required: true
        schema:
          type: string
          format: uuid
      - name: direction
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    post:
      tags:
      - ROC
      summary: Create ROC project
      description: Create a new outbound ROC request (DRAFT)
      operationId: createProject
      parameters:
      - name: customerId
        in: query
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RocCreateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/submit:
    post:
      tags:
      - ROC
      summary: Submit ROC to Somos
      operationId: submitRoc
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RocSubmitRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/refresh:
    post:
      tags:
      - ROC
      summary: Refresh ROC status from Somos
      operationId: refreshProject
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/loa/upload:
    post:
      tags:
      - ROC
      summary: Upload LOA file
      operationId: uploadLoa
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/loa/generate:
    post:
      tags:
      - ROC
      summary: Generate LOA from Somos
      operationId: generateLoa
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RocLoaGenerateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/escalate-hdi:
    post:
      tags:
      - ROC
      summary: Escalate to Somos Help Desk
      operationId: escalateToHdi
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      - name: loaId
        in: query
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/documents/upload:
    post:
      tags:
      - ROC
      summary: Upload additional document
      operationId: uploadDocument
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: true
        schema:
          type: string
      - name: fileTitle
        in: query
        required: false
        schema:
          type: string
      - name: notes
        in: query
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
              - file
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}:
    get:
      tags:
      - ROC
      summary: Get ROC project details
      operationId: getProject
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/documents:
    get:
      tags:
      - ROC
      summary: Get documents for ROC project
      operationId: getProjectDocuments
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/documents/{documentId}/download:
    get:
      tags:
      - ROC
      summary: Download document
      operationId: downloadDocument
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: documentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: respOrgId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/details:
    get:
      tags:
      - ROC
      summary: Get per-TFN details for ROC project
      operationId: getProjectDetails
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
  /v1/roc/projects/{projectId}/audit:
    get:
      tags:
      - ROC
      summary: Get audit log for ROC project
      operationId: getProjectAudit
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    servers:
    - url: https://api.tniq.ringer.tel
      description: Production
    - url: https://tniq-api.ringer.tel
      description: Production (legacy alias)
    - url: https://staging-api.ringer.tel
      description: Staging
components:
  schemas:
    RocSubmitRequest:
      required:
      - respOrgId
      type: object
      properties:
        respOrgId:
          type: string
        contactInformation:
          type: string
    TfnActionDto:
      required:
      - actionCode
      - tfn
      type: object
      properties:
        tfn:
          type: string
        actionCode:
          type: string
        rejectNote:
          type: string
    RocLoaGenerateRequest:
      required:
      - address1
      - city
      - contactName
      - contactPhone
      - contactTitle
      - custName
      - respOrgId
      - state
      - zipCode
      type: object
      properties:
        respOrgId:
          type: string
        custName:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        zipCode:
          type: string
        contactName:
          type: string
        contactTitle:
          type: string
        contactPhone:
          type: string
        email:
          type: string
    RocCreateRequest:
      required:
      - entityId
      - newRespOrgId
      - requestType
      - tfns
      type: object
      properties:
        entityId:
          type: string
        newRespOrgId:
          pattern: ^[a-zA-Z0-9]{5}$
          type: string
        requestType:
          type: string
        tfns:
          type: array
          items:
            pattern: ^[0-9]{10}$
            type: string
        effectiveDate:
          type: string
          format: date
        notes:
          maxLength: 1000
          minLength: 0
          type: string
    RocProcessRequest:
      required:
      - actions
      - respOrgId
      type: object
      properties:
        respOrgId:
          type: string
        actions:
          type: array
          items:
            $ref: '#/components/schemas/TfnActionDto'
    RocSyncRequest:
      required:
      - customerId
      - direction
      - endDate
      - respOrgId
      - startDate
      type: object
      properties:
        customerId:
          type: string
          format: uuid
        respOrgId:
          type: string
        direction:
          type: string
        startDate:
          type: string
        endDate:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Bearer token authentication. Pass your API token or user JWT in the Authorization header: Authorization: Bearer YOUR_TOKEN'
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- teliax-tniq-openapi.json
- teliax-tniq-openapi.yml