AI Assistants
Multi-Task Assistants
Phone Numbers
Campaigns
Account
Phone Numbers
Get Phone Number
Returns a single phone number based on the ID supplied
GET
/
phone-numbers
/
{phone_number_id}
curl --request GET \
--url https://api.puretalk.ai/api/phone-numbers/{phone_number_id} \
--header 'X-API-KEY: <api-key>'
{
"msg": "Phone number retrieved successfully.",
"err": false,
"results": {
"user": {
"name": "John Doe",
"dp": "https://api.puretalk.ai/api/users/1/profile_picture.jpg",
"email": "[email protected]"
},
"ai_assistant": {
"assistant_id": "00ef5401-cbfb-450a-a806-adad5dd907f3",
"name": "My AI Assistant",
"variables": [
"<string>"
]
},
"additional_data": {
"postal_code": "<string>",
"capabilities": {
"voice": true,
"SMS": true,
"MMS": true
},
"locality": "<string>",
"region": "<string>",
"iso_country": "<string>"
},
"phone_number_id": "<string>",
"phone_number": "<string>",
"friendly_name": "<string>",
"provider": "<string>",
"provider_id": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Authorizations
Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.
Path Parameters
ID of phone number to return
Response
200
application/json
Phone number response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.puretalk.ai/api/phone-numbers/{phone_number_id} \
--header 'X-API-KEY: <api-key>'
{
"msg": "Phone number retrieved successfully.",
"err": false,
"results": {
"user": {
"name": "John Doe",
"dp": "https://api.puretalk.ai/api/users/1/profile_picture.jpg",
"email": "[email protected]"
},
"ai_assistant": {
"assistant_id": "00ef5401-cbfb-450a-a806-adad5dd907f3",
"name": "My AI Assistant",
"variables": [
"<string>"
]
},
"additional_data": {
"postal_code": "<string>",
"capabilities": {
"voice": true,
"SMS": true,
"MMS": true
},
"locality": "<string>",
"region": "<string>",
"iso_country": "<string>"
},
"phone_number_id": "<string>",
"phone_number": "<string>",
"friendly_name": "<string>",
"provider": "<string>",
"provider_id": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}