Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sends a multimedia message to a whatsapp customer.

Status
colourYellow
titleHTTP POST
/livechat/:domain/sendExternalMultimediaMessageToCtlivesocial

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleNO

Status
titleSTRING

Unique domain identifier

Authorization: StatustitleBASIC AUTHsee Authentication mechanisms

Request Body:

Type:
Status
titleJSON

Name

Mandatory

Type

Description

customerPhoneNumber

Status
colourRed
titleYES

Status
titleSTRING

customer phone number

servicePhoneNumber

Status
colourRed
titleYES

Status
titleSTRING

whatsapp business number

document

Status
colourRed
titleYES

Status
titleSTRING

base64 string

messageType

Status
colourRed
titleYES

Status
titleSTRING

can assume one of the following values:

  • IMAGE

  • DOCUMENT

fileName

Status
colourRed
titleYES

Status
titleSTRING

file name (extension included)

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

error

Status
titleNULL
/
Status
titleSTRING

Contains the error description if an error has occurred in the request

Example:

Request

http://<hostname>:<port>/livechat/default/sendExternalMultimediaMessageToCtlivesocial

...