WhatsApp messaging

List all messages

Returns all messages from the specified chat by parameters.

get/admin/messengers/whatsapp/{chat_id}/messages

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/messengers/whatsapp/{chat_id}/messages
  • Auth: HTTP basic

Path parameters

chat_idnumber double required
Example:1

The ID of the chat.

Query parameters

paramsstring required
Example:http_build_query($search)

Any parameters of record. <br>You should set at least one record`s parameter. <br>This parameters should be converted to query string.<br>For example:<br>$search = [ <br>  'main_attributes' => [<br>    'inbound' => 1<br>   ], <br>  'limit' => 15,<br>  'offset' => 5<br>];<br>

Response

idnumber required

Message ID

chat_idnumber required

Chat ID

conversation_idnumber required

Conversation ID

external_idstring

External ID

customer_idnumber

Customer ID

admin_idnumber

Admin ID

ticket_idnumber

Ticket ID

bodystring

Message body

status_idstring required

Message status

inboundboolean

Indicates whether the message is inbound

errorstring

Error text

latitudestring

Latitude

longitudestring

Longitude

addressstring

Address

created_atstring required

Datetime

updated_atstring required

Datetime

Example response

[
  {
    "id": 1,
    "chat_id": 1,
    "conversation_id": 1,
    "external_id": "SM333a12222",
    "customer_id": 1,
    "admin_id": 1,
    "ticket_id": 1,
    "body": "Text",
    "status_id": "delivered",
    "inbound": false,
    "error": "Code 200",
    "latitude": "123.11",
    "longitude": "312.111",
    "address": "Street 3",
    "attachments": [
      {
        "filename_original": "image.png",
        "download_link: `https://your.splynx.domain/files?id={hash_id}&type=files_upload`": "",
        "size": 3120
      }
    ],
    "actions": [],
    "created_at": "2023-12-04 05:45:02",
    "updated_at": "2023-12-04 05:45:02"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.