Send Contact
You can use the "Send Contact" API in one case only: You reply to a message that the client sent, within 24 hours since the client sent his last message.
If you send a message to a new client, or try to send a message to an old client (old client means that more than 24 hours has passed since his last message), you must use the "Send Template Message" API instead. Sending contact is not available for template message, therefore, sending a contact message can only be when replying to a client. If you send a template message to the client, and the client did not reply yet, and you want to send another message to him, you must use the template message again.
More Remarks
You can only send a contact to private people, not groups.
The billing is per "conversation". conversation means a 24 hours session between you and the client (this 24 hours conversation session is unrelated to the 24 hours timer for template message)
You can send unlimited messages within the 24 hours session time of a conversation.
24 hours session conversation starts when you send a message to the client.
Every time the user replies, the template message session resets. which means that you don't have to use template message during this 24 hours template message session.
Settings:
URL | |
Method | JSON via POST |
Body:
Parameter | Description / Example | Mandatory |
|---|---|---|
apiKey | Your API key for the service | yes |
from | your WhatsApp account. international number without +. for example: 972771234567 | yes |
to | The number you want to send the message to. for example: 972501234567 | yes |
contact_name | contact name (first name or full name) | yes |
contact_phone | contact phone number. using any format you like (0501234567 or 972501234567). we recommend using the international number format (972501234567) | yes |
contact_email | email address (example@example.com) | no |
contact_birthday | birthday. using format: YYYY-MM-DD | no |
address_street | street address | no |
address_city | city | no |
address_country | country | no |
website | any website URL | no |
replyTo | In case you want to reply to a message that the end user has sent (quoted message), here you can provide the unique ID of that message | no |
showRequest | You can get back in the response an object with all the request you sent (without the 'apiKey') default is off (0) 1 - enable | no |
Response:
{
"status": "OK",
"unique": "65dfd4r4dref34rdfxd34r",
"contact_name": "The contact name you sent",
"contact_phone": "The contact phone you sent",
"timestamp": 1600115719,
"from": "972507654321",
"to": "972501234567",
"templateTimeLeft": "400",
"reason": 1
}
Response-Explain:
Parameter | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL **Note: OK status doesn't mean the message arrived to the end user. it only means that the system received your request. You should listen to webhooks to see the status of your message. | ||||||||||||||||||||
unique | unique ID for any message | ||||||||||||||||||||
contact_name | the contact you sent | ||||||||||||||||||||
contact_phone | the phone you sent | ||||||||||||||||||||
timestamp | time stamp | ||||||||||||||||||||
from | your WhatsApp account | ||||||||||||||||||||
to | the number that the message was sent to | ||||||||||||||||||||
templateTimeLeft | amount of minutes left since client's last message. if passed, you must use Template Message. This value resets every time the client is sending you a message. | ||||||||||||||||||||
conversationTimeLeft | Deprecated this value is no longer in use. Conversation time left is now part of the webhook response instead. This parameter will be removed in future updates. until then, this value will show 0 always. | ||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|