Message

This page provides API documentation for sending WABA template messages in Saleschat.pro, including required parameters and template validation rules for successful message delivery.

Send WABA Template Message V3

post

  • Roles Allowed: ADMIN

  • Impersonated User Allowed: FALSE

  • Partner Allowed: TRUE

  • chatroomId is the ID of the chatroom where the message should be sent

  • remoteTemplateId is the WABA template's ID for sending the template message

  • skip_governance is an optional field for choosing governance allowance for a message. By default, it is set to true

  • For any of the above values, if a resource is not found or does not belong to the requested org, an exception will be thrown

  • templateParams are required if the template body has parameters.

  • If a template parameter is present, it must have a value and tag.

  • If a template parameter is of type USER_FILL and no value is present, an exception will be thrown.

  • If a template parameter is of type AUTO_FILL, the provided value will be overwritten by the computed value

  • Media & Button Templates are supported through this API.

  • For static media templates, no extra parameters are required.

  • For dynamic media templates, a parameter with the correct tag and file_id as the value must be provided.

  • For dynamic URL button templates, a parameter with the correct tag and URL parameter as the value must be provided.

  • For send_via_participant = true, the flow will find an existing agent in the chatroom and send the message on its behalf. If no agent is found, it will send via bot.

  • For send_via_participant = false, the message is sent via a bot. By default, the value for sendViaParticipant is assumed to be false

  • The bump field allows to you to control whether sending message should bump the chatroom to the top or not in the list.

  • The bump_response field allows to you to control whether an interaction with the template (like button press) would bump the chatroom to top.

  • The relay_response field allows to you to control whether an interaction with the template (like button press) should be sent to the preconfigured webhook

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
orgIdstringRequired
Query parameters
dispositionstring · max: 256Optional
relay_responsestringOptionalDefault: false
bumpstringOptionalDefault: true
bump_responsestringOptionalDefault: true
Body
chatroom_idstringRequired
remote_template_idstringRequired
skip_governancebooleanOptional

Whether to skip governance checks

Default: true
send_via_participantbooleanOptional

Whether to send via the agent

Default: false
Responses
200

Successfully registered request to send message

application/json
post
/v3/orgs/{orgId}/waba/templates/send
POST /v3/orgs/{orgId}/waba/templates/send HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "chatroom_id": "text",
  "remote_template_id": "text",
  "template_params": [
    {
      "tag": "name",
      "value": "John"
    }
  ],
  "skip_governance": true,
  "send_via_participant": false
}
{
  "request_id": "text",
  "error_msg": "text",
  "error_code": "WORKFLOW_INIT_FAILURE"
}

PreviousMedia

Last updated