Return all phone numbers

What it does

Returns all phone numbers created by your API key. You can specify attributes to filter the results.

Endpoint

GET

/byon/phonebook/v1/numbers

Request Querystring Parameters

Attributes

Description

requestId
optional (query)

A filter on the list based on the requestId (string) field.

contactId
optional (query)

A filter on the list based on the contactId (string) field.

page
optional (query)

A filter on the list based on the page (integer) field.

size
optional (query)

A filter on the list based on the size (integer) field.

Curl example

curl -X GET "https://api.tyntec.com/byon/phonebook/v1/numbers" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"

Curl example with optional Attributes

curl -X GET "https://api.tyntec.com/byon/phonebook/v1/numbers?contactId=26c99e4d97b44c9aa50bf7fb29801ebe&page=1&size=1" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"

 

Responses

Code

Description

200

The list of phones requests

 

Example Value

[
  {
	"size": 0,
	"page": 0,
	"phoneNumbers": [
      {
        "accountId": "string",
	"phoneNumber": "string",
	"requestId": "string",
	"contactId": "string",
        "requestId": "string",
        "loaReady": "string"
      }
    ]
  }
]

Response body example

{
  "size": 2,
  "page": 2,
  "phoneNumbers": [
    {
      "accountId": "CPaasAccountName",
      "phoneNumber": "+4923456553345",
      "requestId": "87d677f524a14cc3bfabe6ea97015643",
      "contactId": "26c99e4d97b44c9aa50bf7fb29801ebe",
      "country": "DE",
      "loaReady": false
    },
    {
      "accountId": "henry",
      "phoneNumber": "+4923142144",
      "requestId": "2cfa638e3d9c4da399c4fa70a3698717",
      "contactId": "26c99e4d97b44c9aa50bf7fb29801ebe",
      "country": "DE",
      "loaReady": true
    }
  ]
}

401

Unauthorized

403

Forbidden

404

Not Found

500

Something went wrong :-(Example Value{  "code": "string",  "message": "string",  "timestamp": 0}