{
  1. Introduction
    1. Authentication
  2. Inbound Numbers
    1. Retrieve inbound numbers
    2. Export inbound numbers to Excel

Introduction

This documentation provides information for the APIs related to Talk.

Authentication

API Key (GUID)

To make use of our APIs, you will need an API key in order to authenticate yourself.

This ID must be present in every request inside an header named X-CM-PRODUCTTOKEN. You can find the API Key for your voice account under API Settings in the Voice Management App (https://voiceapp.cmtelecom.com).

Voice Account ID (GUID)

The Voice Account ID must be provided for every request in the URL.

Inbound Numbers

This sections describes information regarding inbound numbers that are linked to your voice account.

Retrieve inbound numbers in JSON

GET https://api.cmtelecom.com/inboundnumberapi/v2/{voiceAccountId}/inboundnumbers?skip=0&take=10

Parameters

Type Name Description Schema
Path voiceAccountId
required
Your voice account identifier. string (uuid)
Query skip
Amount of items being skipped.
Minimum value is 0.
number
Query take
required
Amount of items to be retrieved.
Minimum value is 1.
number

Response

Header Description Schema
X-Cm-Pagination-Skip Amount of items being skipped. number
X-Cm-Pagination-Take Amount of items being retrieved. number
X-Cm-Pagination-Total Total items that can be retrieved. number
Content-Type application/json -
[
  {
    "Number": string,
    "OriginalNumber": string,
    "VoiceAccount": {
      "CreatedOn": datetime,
      "Name": string,
      "ProductAccountId": string,
      "ExternalId": int,
      "ExternalName": string,
      "IsActive": boolean,
      "IsTest": boolean
    },
    "Application": {
      "Guid": string,
      "Name": string,
      "IsConfigurable": boolean,
      "DisplayCode": int
    },
    "DistributionGroup": {
      "guid": string,
      "name": string,
      "createdOn": datetime,
      "updatedOn": datetime,
      "dispatchers": [
      ],
      "inboundRoutes": [
        {
          "createdOn": datetime,
          "phoneNumber": long,
          "description": string,
          "distributionGroupId": int,
          "distributionAlgorithm": int
        }
      ]
    },
    "Country": {
      "Code": string,
      "Name": string,
      "Prefix": string,
      "Zone": string
    },
    "ValidFrom": datetime,
    "ValidTo": datetime?,
    "NumberType": string,
    "UpdatedOn": datetime,
    "Status": {
      "Guid": string,
      "Name": string
    }
  }
]

[
  {
    "Number": "31612345678",
    "OriginalNumber": "",
    "VoiceAccount": {
      "CreatedOn": "2019-01-01T00:00:00",
      "Name": "Voice account name",
      "ProductAccountId": "00000000-0000-0000-0000-000000000000",
      "ExternalId": 1,
      "ExternalName": "Voice account external name",
      "IsActive": true,
      "IsTest": false
    },
    "Application": {
      "Guid": "00000000-0000-0000-0000-000000000000",
      "Name": "SIP trunking",
      "IsConfigurable": true,
      "DisplayCode": 1
    },
    "DistributionGroup": null,
    "Country": {
      "Code": "NL",
      "Name": "Netherlands",
      "Prefix": "31",
      "Zone": "EER"
    },
    "ValidFrom": "2019-01-01T00:00:00",
    "ValidTo": null,
    "NumberType": "FIXED_LINE",
    "UpdatedOn": "2019-01-01T00:00:00",
    "Status": {
      "Guid": "00000000-0000-0000-0000-000000000000",
      "Name": "Operational"
    }
  }
]

Export inbound numbers to Excel

GET https://api.cmtelecom.com/inboundnumberapi/v2/{voiceAccountId}/inboundnumbers/export

Parameters

Type Name Description Schema
Path voiceAccountId
required
Your voice account identifier. string (uuid)

Response

Header Description Schema
X-CM-FILENAME Name of the generated Excel file. string
Content-Type application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -