Contact Phones
GET /:account/contact_phones{?q}
Provides a list of all the contact phones linked to contacts linked to the account.
Examples
##
Request
GET /my_account/contact_phones
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /my_account/contact_phones
Response
Status
200
Response Type
Example Body
{
"@type": "hydra:Collection",
"id": "/my_account/contact_phones",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 5,
"members": [
{
"@type": "RecipientContactPhone",
"id": "/contact_phones/mxvbRw",
"@context": "/contexts/RecipientContactPhone.jsonld",
"phoneNumber": "+13035551234",
"formattedPhoneNumber": "(303) 555-1234",
"extension": null,
"type": "Mobile",
"deliverabilityStatus": "unknown",
"contact": {
"id": "/contacts/Vled2N",
"@type": "ContactItem",
"@context": "/contexts/Contact.jsonld",
"name": "Jamel Hirthe",
"firstName": "Jamel",
"lastName": "Hirthe",
"phones": "/contacts/Vled2N/phones",
"notes": "/contacts/Vled2N/notes",
"data": {},
"conversations": "/contacts/Vled2N/conversations",
"createdAt": "2020-01-06T21:49:58.312Z"
}
}
],
"view": {
"@type": "hydra:PartialCollectionView",
"id": "/my_account/contact_phones",
"@context": "/contexts/hydra:PartialCollectionView.jsonld",
"first": "/my_account/contact_phones",
"next": null,
"previous": null
}
}
Searching for a contact phone
Request
GET /my_account/contact_phones?q=Chuck
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /my_account/contact_phones?q=Chuck
Response
Status
200
Response Type
Example Body
{
"@type": "hydra:Collection",
"id": "/my_account/contact_phones?q=Chuck",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 5,
"members": [
{
"@type": "RecipientContactPhone",
"id": "/contact_phones/mxvbRw",
"@context": "/contexts/RecipientContactPhone.jsonld",
"phoneNumber": "+13035551234",
"formattedPhoneNumber": "(303) 555-1234",
"extension": null,
"type": "Mobile",
"deliverabilityStatus": "unknown",
"contact": {
"id": "/contacts/Vled2N",
"@type": "ContactItem",
"@context": "/contexts/Contact.jsonld",
"name": "Jamel Hirthe",
"firstName": "Jamel",
"lastName": "Hirthe",
"phones": "/contacts/Vled2N/phones",
"notes": "/contacts/Vled2N/notes",
"data": {},
"conversations": "/contacts/Vled2N/conversations",
"createdAt": "2020-01-06T21:49:58.312Z"
}
}
],
"view": {
"@type": "hydra:PartialCollectionView",
"id": "/my_account/contact_phones?q=Chuck",
"@context": "/contexts/hydra:PartialCollectionView.jsonld",
"first": "/my_account/contact_phones?q=Chuck",
"next": null,
"previous": null
}
}