POST api/WhatsAppOrderBot/SendEbanqoWhatsappMessage
Request Information
URI Parameters
None.
Body Parameters
EbanqoTemplateData| Name | Description | Type | Additional information |
|---|---|---|---|
| agent_code | string |
None. |
|
| message_type | string |
None. |
|
| recipients | Collection of Recipients |
None. |
|
| text | string |
None. |
|
| template_name | string |
None. |
|
| auto_assign | boolean |
None. |
|
| body_placeholders | Collection of BodyPlaceholders |
None. |
|
| template_type | string |
None. |
|
| file_url | string |
None. |
|
| namespace | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"agent_code": "sample string 1",
"message_type": "sample string 2",
"recipients": [
{
"id": "sample string 1",
"platform": "sample string 2",
"user_code": "sample string 3",
"name": "sample string 4"
},
{
"id": "sample string 1",
"platform": "sample string 2",
"user_code": "sample string 3",
"name": "sample string 4"
}
],
"text": "sample string 3",
"template_name": "sample string 4",
"auto_assign": true,
"body_placeholders": [
{
"key": "sample string 1",
"type": "sample string 2",
"value": "sample string 3"
},
{
"key": "sample string 1",
"type": "sample string 2",
"value": "sample string 3"
}
],
"template_type": "sample string 6",
"file_url": "sample string 7",
"namespace": "sample string 8"
}
application/xml, text/xml
Sample:
<EbanqoTemplateData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
<agentCode>sample string 1</agentCode>
<autoAssign>true</autoAssign>
<bodyPlaceholders>
<BodyPlaceholders>
<key>sample string 1</key>
<type>sample string 2</type>
<value>sample string 3</value>
</BodyPlaceholders>
<BodyPlaceholders>
<key>sample string 1</key>
<type>sample string 2</type>
<value>sample string 3</value>
</BodyPlaceholders>
</bodyPlaceholders>
<fileUrl>sample string 7</fileUrl>
<messageText>sample string 3</messageText>
<messageType>sample string 2</messageType>
<namespaceData>sample string 8</namespaceData>
<recipients>
<Recipients>
<customerId>sample string 1</customerId>
<customerName>sample string 4</customerName>
<customerPhone>sample string 3</customerPhone>
<platform>sample string 2</platform>
</Recipients>
<Recipients>
<customerId>sample string 1</customerId>
<customerName>sample string 4</customerName>
<customerPhone>sample string 3</customerPhone>
<platform>sample string 2</platform>
</Recipients>
</recipients>
<templateName>sample string 4</templateName>
<templateType>sample string 6</templateType>
</EbanqoTemplateData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VCAPIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | string |
None. |
|
| dateTime | string |
None. |
|
| StatusCode | integer |
None. |
|
| ErrorMessage | string |
None. |
|
| Result | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Version": "1.0.0",
"dateTime": "2025/10/31 22:17:31",
"StatusCode": 1,
"ErrorMessage": "sample string 2",
"Result": {}
}
application/xml, text/xml
Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model"> <ErrorMessage>sample string 2</ErrorMessage> <Result /> <StatusCode>1</StatusCode> </VCAPIResponse>