Notify Altegio about a new chat message

Request

Marks the installed Chat frame as having unread messages. Altegio updates the timetable UI and may create a notification-center item according to the location's Chat settings. If lead saving is enabled and phone_from does not match a client, Altegio may create a lead.

The application must belong to the authenticated partner and its Chat frame must already be installed for the location (normally by passing chat_url to the installation callback).

Security

BearerPartner

Headers

Acceptstringrequired

Default:"application/vnd.api.v2+json"

Bodyapplication/jsonrequired

salon_idinteger, >= 1required

Location ID.

application_idinteger, >= 1required

Marketplace application ID.

phone_fromstring^\d+$required

Sender phone number as digits.

messagestringrequired

Message preview used by notification-center delivery.

namestring, non-emptyrequired

Sender name used if lead creation is enabled.

curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/marketplace/application/new_message \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salon_id": 1,
    "application_id": 1,
    "phone_from": "string",
    "message": "string",
    "name": "string"
  }'

Responses

Chat unread/highlight state updated.

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataobject or null(No data in response)

Response data.

Example:null

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": null,
  "meta": {}
}