AI Assistants
Multi-Task Assistants
Phone Numbers
Campaigns
Account
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"
}
}Get Phone Number
Returns a single phone number based on the ID supplied
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
Phone number response
A success message
"Phone number retrieved successfully."
Indicates if there was an error
false
A phone number object
Show child attributes
Show child attributes
The user object
Show child attributes
Show child attributes
The name of the user
"John Doe"
The profile picture of the user
"https://api.puretalk.ai/api/users/1/profile_picture.jpg"
The email of the user
Show child attributes
Show child attributes
The postal code of the phone number
The locality of the phone number
The region of the phone number
The ISO country code of the phone number
The ID of the phone number
The phone number
The friendly name of the phone number
The provider of the phone number
The provider ID of the phone number
Indicates if the phone number is active
The date and time the phone number was created
The date and time the phone number was updated
Was this page helpful?