Create message
Create message. See the OpenAPI-defined parameters, request body, and responses below.
/MessageCreate message. See the OpenAPI-defined parameters, request body, and responses below.
OpenAPI description: Este endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa.
Authentication
Authentication required. Send your user API key in the X-API-Key header.
Parameters
This operation has no path, query, or header parameters.
Request body
Content type: multipart/form-data · Schema: object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
file | string · binary | No | — | — |
Id | integer · int32 | No | — | — |
CreatedAt | string · date-time | No | — | — |
From | string | No | — | — |
To | string | No | — | — |
Content | string | No | — | — |
ConversationId | integer · int32 | No | — | — |
Sentiment | string | No | — | — |
Offset | string | No | — | — |
IsNPS | boolean | No | — | — |
ContentSid | string | No | — | — |
MessageType | MessageType | No | — | — |
ConversationTemplateId | integer · int32 | No | — | — |
MediaUrl | string | No | — | — |
MediaFileName | string | No | — | — |
TenantId | integer · int32 | No | — | — |
UserId | integer · int32 | No | — | — |
ContentVariables | string | No | — | — |
MessageSid | string | No | — | — |
MessageStatus | MessageStatus | No | — | — |
Sent | boolean | No | — | — |
Delivered | boolean | No | — | — |
Read | boolean | No | — | — |
ErrorCode | string | No | — | — |
ErrorMessage | string | No | — | — |
IsReadByUser | boolean | No | — | — |
DocumentId | integer · int32 | No | — | — |
Example request
curl --request POST \
--url 'https://api.zild.ai/Message' \
--header 'X-API-Key: YOUR_USER_API_KEY' \
--form 'file=@file' \
--form 'Id={Id}' \
--form 'CreatedAt={CreatedAt}' \
--form 'From={From}' \
--form 'To={To}' \
--form 'Content={Content}' \
--form 'ConversationId={ConversationId}' \
--form 'Sentiment={Sentiment}' \
--form 'Offset={Offset}' \
--form 'IsNPS={IsNPS}' \
--form 'ContentSid={ContentSid}' \
--form 'MessageType={MessageType}' \
--form 'ConversationTemplateId={ConversationTemplateId}' \
--form 'MediaUrl={MediaUrl}' \
--form 'MediaFileName={MediaFileName}' \
--form 'TenantId={TenantId}' \
--form 'UserId={UserId}' \
--form 'ContentVariables={ContentVariables}' \
--form 'MessageSid={MessageSid}' \
--form 'MessageStatus={MessageStatus}' \
--form 'Sent={Sent}' \
--form 'Delivered={Delivered}' \
--form 'Read={Read}' \
--form 'ErrorCode={ErrorCode}' \
--form 'ErrorMessage={ErrorMessage}' \
--form 'IsReadByUser={IsReadByUser}' \
--form 'DocumentId={DocumentId}'
Responses
| Status | Description | Response body |
|---|---|---|
200 | Mensagem criada com sucesso | No response body is defined. |
Data models
MessageStatus
0 = Queued; 1 = Sending; 2 = Sent; 3 = Delivered; 4 = Receiving; 5 = Received; 6 = Accepted; 7 = Scheduled; 8 = Read; 9 = Undelivered; 10 = Canceled; 11 = Failed
integer
MessageType
0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact
integer