{"request_id":"f44e3f43-6d4e-4e46-becd-21993f3dcb8e","messages":[{"msg_id":"6d29d646-4e09-11ee-84f4-0242ac190006","originator":"9190615xxxx","recipient":"+9190617xxxx","reference":{"cust_ref":"customerRef","message_tag1":"...","message_tag2":"...","message_tag3":"...","message_tag4":"...","message_tag5":"...","conversation_id":"..."},"conversation_type":"marketing","message_type":"TEMPLATE","template_id":"marketing","waConvId":"db311b5709a13ac72c1bd9f293c68625","status":"read","reason":"Read by the user"}],"request_stage":"processed","schedule_time":null}
404 - Not Found
{"detail":{"code":"WHATSAPP_LOG_NOT_EXISTS","message":"Given whatsapp message request id not exists in the system. Please Try Again!"}}
Response Parameters
Parameter
Value / Pattern
Example(s)
msg_id
The message id for each message in the request
5c8d9ed8-590b-11ed-93d2-0242ac140018
originator
Sender/Header numbers
+971509752655
recipient
Destination numbers
+971509752655
cust_ref
A unique id send by the customer for every message
message_tag1-message_tag5
To Specify the message tag
conversation_id
Some Optional Conversation ID
conversation_type
Type of your conversation. It includes marketing, service, utility
marketing
message_type
Type of the message inside the content. Valid values: TEXT, ATTACHMENT, LOCATION, CONTACTS, TEMPLATE.
TEMPLATE
template_id
ID of your template
marketing
waConvId
whatsapp conversation id
db311b5709a13ac72c1bd9f293c68625
reason
Description of your status
Read by the user
status
This is the status of the message, and we have the following statuses: [delivered - Delivered to destination and confirmed], [sent - Was sent to telecom and is awaiting acknowledgement], [scheduled - Message scheduled], [un_delivered - Failed delivery], [processed - message is processed], [rejected - Rejected the message], [insufficient_credit - User does not have enough credit], [read - Read by the user]