Return specific phone number

What it does

Returns the specific phone number entity created by your API key.

Endpoint

GET

/byon/phonebook/v1/numbers/{phoneNumber}

Request Querystring Parameters

Attributes

Description

phoneNumber
required (path)

The phoneNumber (string) field.

Curl example

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

 

Responses

Code

Description

200

The Phone Number entity

 

Example Value

[ 
  { 
	"accountId": "string", 
	"phoneNumber": "string",
	"requestId": "string", 
	"contactId": "string", 
	"country": "string", 
	"loaReady": bool 
  } 
]

Response body example

[ 
  { 
	"accountId": "CPaasAccountName", 
	"phoneNumber": "+492315551337", 
	"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}