/api/v1/connections/{id}/send-message

POST

/api/v1/connections/{id}/send-message

curl --request POST \
  --url https://api.endless.zaia.app/api/v1/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/send-message \
  --header 'Content-Type: application/json' \
  --data '{ "content": { "text": "example" }, "externalId": "example", "identifier": "example" }'

• API Server

Sends a message through a connection.

Parameters

Path Parameters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Body^required

Media typeapplication/json

object

content

required

Any of:

object

object

text

required

string

>= 1 characters

object

object

attachments

required

Array

Any of:

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: png

id

required

A UUID v4 string that identifies an entity.

string format: uuid

name

required

string

>= 1 characters

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: pdf

id

required

A UUID v4 string that identifies an entity.

string format: uuid

name

required

string

>= 1 characters

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: wav

id

required

A UUID v4 string that identifies an entity.

string format: uuid

mode

required

string

Allowed values: message

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: wav

id

required

A UUID v4 string that identifies an entity.

string format: uuid

mode

required

string

Allowed values: attachment

name

required

string

>= 1 characters

object

object

attachments

required

Array

Any of:

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: png

id

required

A UUID v4 string that identifies an entity.

string format: uuid

name

required

string

>= 1 characters

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: pdf

id

required

A UUID v4 string that identifies an entity.

string format: uuid

name

required

string

>= 1 characters

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: wav

id

required

A UUID v4 string that identifies an entity.

string format: uuid

mode

required

string

Allowed values: message

object

object

base64

required

A base64 encoded string with prefix.

string

/^data:.*;base64,/

extension

required

string

Allowed values: wav

id

required

A UUID v4 string that identifies an entity.

string format: uuid

mode

required

string

Allowed values: attachment

name

required

string

>= 1 characters

text

required

string

>= 1 characters

object

object

template

required

object

body

object

text

string

variables

Array<object>

default:

object

parameterName

required

string

value

required

string

buttons

object

texts

Array<string>

urlVariables

Array<object>

object

buttonIndex

required

number

value

required

string

<= 2000 characters

category

string

nullable

Allowed values: AUTHENTICATION MARKETING UTILITY

footer

string

<= 60 characters

header

object

imageUrl

string

text

string

<= 60 characters

variables

Array<object>

object

parameterName

required

string

value

required

string

language

required

string

>= 1 characters

name

required

string

>= 1 characters

externalId

required

string

nullable

identifier

required

string

nullable

Responses

200

Message sent successfully.

Media typeapplication/json

object

message

required

An informative message for a call that has no effective result to be returned.

string

Example^generated

{
  "message": "example"
}

404

Connection not found.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

500

Failed to send message.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}