Aller au contenu principal

GET /contacts/phone/:number

Get a specific contact given a phone_number. When the channel_uuid is specified, the contact will be searched by the phone number and the channel, otherwise by default the lookup will be performed on the main WhatsApp channel.

Required Parameters

ParameterTypeDescription
phone_numberstringThe phone number of the contact

Optional Parameters

ParameterTypeDescription
channel_uuidstringThe channel UUID to search the contact by.

Example Request

curl -X GET "https://api.callbell.eu/v1/contacts/phone/5790372023" \
-H "Authorization: Bearer test_gshuPaZoeEG6ovbc8M79w0QyM" \
-H "Content-Type: application/json"

Response

ParameterTypeDescription
contactContactThe object representing the contact.

Example Response

response.json
{
"contact": {
"uuid": "414a6d692bd645ed803f2e7ce360d4c8",
"name": "John Doe",
"phoneNumber": "+123 456 789",
"avatarUrl": null,
"createdAt": "2020-11-13T21:08:53Z",
"source": "whatsapp",
"href": "https://dash.callbell.eu/contacts/414a6d692bd645ed803f2e7ce360d4c8",
"conversationHref": "https://dash.callbell.eu/chat/f3670b13446b412796238b1cd78899f9",
"tags": ["sales", "lead"],
"assignedUser": null,
"customFields": {
"Address": "Oxford Street 123",
"Billing Address": "Oxford Street 123",
"VAT": "ABC123DCE456"
}
}
}