List Numbers

API Docs by APIMATIC

List Numbers
#

  • REST
  • Java

List Numbers
#

Returns a list of phone numbers owned by the contact center.

GET /api/numbers/v1/numbers

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Header
Number
Query

Page number


Responses

  • 200
  • 401
  • 429

Success

application/json

Type

Object

{
  "numbers": [
    {
      "number": "1234567890",
      "created_at": "2023-07-24T15:50:21.208Z",
      "label": "My number",
      "country": "United States",
      "city": "City",
      "type": "geographic",
      "provider": "Voiso",
      "activation_fee": "1.23",
      "monthly_fee": "2.34",
      "script": {
        "flow": {
          "id": "16510ca2-7386-4829-ac6d-7f7c38a276d0",
          "name": "My Flow"
        },
        "cid_groups": [
          {
            "id": 2,
            "name": "My CID Group"
          }
        ]
      }
    }
  ],
  "metadata": {
    "total": 1,
    "page": 1,
    "page_size": 1
  }
}
  • Request
  • Response
curl -X GET -G \
  --url 'https://{cluster_id}.voiso.com/api/numbers/v1/numbers'  \
  -H 'Authorization: Bearer token: Authorization: Bearer token6' \
  -d 'page=1'