CM.com Sip Accounts API

openapi: 3.2.0
info:
  title: Sip Accounts API
  version: v1
servers:
- url: https://api.cm.com
security:
- X-CM-PRODUCTTOKEN: []
tags:
- name: Sip Accounts
paths:
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}:
    get:
      tags:
      - Sip Accounts
      summary: Get SIP Account
      description: Get a single SIP Account by it's unique identifier.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSipAccount'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: getVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuid
      x-operation-id-source: derived
    delete:
      tags:
      - Sip Accounts
      summary: Delete SIP Account
      description: Delete the given SIP Account.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: deleteVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuid
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts:
    get:
      tags:
      - Sip Accounts
      summary: Get SIP Accounts
      description: Get all SIP Accounts belonging to the given Voice Account.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: includeConfig
        in: query
        description: Whether or not to include the SIP Account configuration, defaults to `true`.
        schema:
          type: boolean
          example: true
        example: true
      - name: q
        in: query
        description: The search query that can be applied to search through the items before they get paginated.
        schema:
          type: string
          example: ''
        example: ''
      - name: skip
        in: query
        description: The amount of items to be skipped, defaults to 0.
        schema:
          type: integer
          format: int32
          example: 0
        example: 0
      - name: take
        in: query
        description: The amount of items to take, defaults to 25.
        schema:
          type: integer
          format: int32
          example: 25
        example: 25
      responses:
        '200':
          description: Success
          headers:
            X-CM-PAGINATION-SKIP:
              description: The amount of items that have been skipped
              schema:
                type: number
            X-CM-PAGINATION-TAKE:
              description: The amount of items that have been taken
              schema:
                type: number
            X-CM-PAGINATION-TOTAL:
              description: The total amount of available items
              schema:
                type: number
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiSipAccount'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
      operationId: getVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccounts
      x-operation-id-source: derived
    post:
      tags:
      - Sip Accounts
      summary: Create SIP Account
      description: Create a new SIP Account for the given Voice Account. The username and password for the new SIP Account will be automatically generated by CM.com.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSipAccount'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
      operationId: postVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccounts
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/enable:
    put:
      tags:
      - Sip Accounts
      summary: Enable SIP Account
      description: Updates the `isActive` state of the SIP Account to true.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: putVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidEnable
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/disable:
    put:
      tags:
      - Sip Accounts
      summary: Disable SIP Account
      description: Updates the `isActive` state of the SIP Account to false, meaning this SIP Account is no longer able to make or receive calls.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: putVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidDisable
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/prison:
    delete:
      tags:
      - Sip Accounts
      summary: Delete SIP Account From Prison
      description: When the wrong password of the SIP Account was entered too many times, the account get's a temporary ban by being put in prison. This endpoint allows you to remove the SIP Account from prison.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: deleteVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidPrison
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/displayname:
    put:
      tags:
      - Sip Accounts
      summary: Update SIP Account Display Name
      description: Update the display name for the given SIP Account.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      requestBody:
        description: CM.Voice.SipAccounts.Api.Models.Api.ApiUpdateDisplayNameRequest
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiUpdateDisplayNameRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUpdateDisplayNameRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiUpdateDisplayNameRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiUpdateDisplayNameRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSipAccount'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: putVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidDisplayname
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/credentials:
    get:
      tags:
      - Sip Accounts
      summary: Get SIP Account Credentials
      description: Get the username and decrypted password for the given SIP Account.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSipAccountCredentials'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: getVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidCredentials
      x-operation-id-source: derived
  /voice-sipaccountsapi/v1/{voiceAccountGuid}/sipAccounts/{sipAccountGuid}/resetpassword:
    put:
      tags:
      - Sip Accounts
      summary: Reset SIP Account Password
      description: Generates a new password for the given SIP Account. The new decrypted password will be returned in the response body.
      parameters:
      - name: voiceAccountGuid
        in: path
        description: Unique identifier of the Voice Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      - name: sipAccountGuid
        in: path
        description: Unique identifier of the SIP Account.
        required: true
        schema:
          type: string
          format: uuid
        example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSipAccountCredentials'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
      operationId: putVoiceSipaccountsapiV1ByVoiceAccountGuidSipAccountsBySipAccountGuidResetpassword
      x-operation-id-source: derived
components:
  schemas:
    ApiSipAccountCredentials:
      title: Sip Account Credentials
      type: object
      properties:
        username:
          type:
          - string
          - 'null'
          description: Username of the SIP Account.
        password:
          type:
          - string
          - 'null'
          description: Password of the SIP Account.
      additionalProperties: false
      description: The login credentials for a SIP Account.
    ErrorCollection:
      title: Error Collection
      type: object
      properties:
        requestId:
          type:
          - string
          - 'null'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ApiSipAccount:
      title: Sip Account
      type: object
      properties:
        guid:
          type:
          - string
          - 'null'
          description: Unique identifier of the SIP Account.
        createdOn:
          type: string
          description: Date and time on which the SIP Account was created.
          format: date-time
        customerAccountGuid:
          type:
          - string
          - 'null'
          description: The unique identifier of the Voice Account which this SIP Account is part of.
        name:
          type:
          - string
          - 'null'
          description: Display name of the SIP Account.
        username:
          type:
          - string
          - 'null'
          description: Username of the SIP Account. The username is generated automatically by CM.com and cannot be changed.
        isActive:
          type: boolean
          description: Whether or not the SIP Account is set to active.
        inPrison:
          type:
          - boolean
          - 'null'
          description: Whether the account has a temporary ban after entering the wrong password too many times.
        config:
          $ref: '#/components/schemas/ApiSipConfig'
      additionalProperties: false
      description: A SIP Account that can be used to make calls via the CM.com Platform.
    ApiUpdateDisplayNameRequest:
      title: Update Display Name Request
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: New display name for the SIP Account.
          example: My new display name
      additionalProperties: false
      description: Api sip Account model
    Error:
      title: Error
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
        source:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiSipConfig:
      title: Sip Config
      type: object
      properties:
        cpsLimit:
          type: integer
          description: Limit of the amount of calls that can be set up per second.
          format: int32
          example: 2
        ccLimit:
          type: integer
          description: Limit of the amount of calls that can take place concurrently.
          format: int32
          example: 100
        alwaysAnonymous:
          type: boolean
          description: Whether or not outbound calls from this SIP Account will always be dialed out with CLI anonymous.
          example: false
        hasAnonymousOverride:
          type: boolean
          description: When set to true, this option guarantees routing that support anonymous calls.
          example: false
        defaultOutboundCallerId:
          type:
          - string
          - 'null'
          description: The CLI used when making outbound calls. This does not override a valid CLI that is already provided in the SIP invite.
          example: ''
        restrictionType:
          type:
          - string
          - 'null'
          description: Sets the type of prefix restrictions placed on this SIP Account, this can be either set to `whitelist` or `blacklist`. When set to `whitelist`, only calls to the given prefixes will be allowed, when set to `blacklist`, only calls to the given prefixes will be blocked.
          example: blacklist
        primaryTrunkId:
          type:
          - string
          - 'null'
          description: Platform name or domain of the primary SIP trunk or DNS that will be used. The `/trunks` and `/platformdomains` endpoints can be used to get a list of currently active SIP Trunks and Platform Domains.
          example: outbound02
        secondaryTrunkId:
          type:
          - string
          - 'null'
          description: Platform name or domain of the secondary (backup) SIP trunk that will be used. The `/trunks` and `/platformdomains` endpoints can be used to get a list of currently active SIP Trunks and Platform Domains. **When using DNS, reach out to support for a backup DNS.**
          example: outbound01
        blockNonEerToEer:
          type: boolean
          description: All calls with a non-European CLI to a European country will be blocked for this SIP account.
          example: false
        allowPremium:
          type: boolean
          description: Allow calls to premium pay-per-minute or pay-per-call numbers.
          example: false
      additionalProperties: false
      description: SIP configuration containing settings that define how a SIP Account can be used.
  securitySchemes:
    X-CM-PRODUCTTOKEN:
      type: apiKey
      description: Your producttoken
      name: X-CM-PRODUCTTOKEN
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true