Create message

Create message. See the OpenAPI-defined parameters, request body, and responses below.

POST /Message

Create 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

PropertyTypeRequiredDescriptionConstraints
filestring · binaryNo——
Idinteger · int32No——
CreatedAtstring · date-timeNo——
FromstringNo——
TostringNo——
ContentstringNo——
ConversationIdinteger · int32No——
SentimentstringNo——
OffsetstringNo——
IsNPSbooleanNo——
ContentSidstringNo——
MessageTypeMessageTypeNo——
ConversationTemplateIdinteger · int32No——
MediaUrlstringNo——
MediaFileNamestringNo——
TenantIdinteger · int32No——
UserIdinteger · int32No——
ContentVariablesstringNo——
MessageSidstringNo——
MessageStatusMessageStatusNo——
SentbooleanNo——
DeliveredbooleanNo——
ReadbooleanNo——
ErrorCodestringNo——
ErrorMessagestringNo——
IsReadByUserbooleanNo——
DocumentIdinteger · int32No——

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

StatusDescriptionResponse body
200Mensagem criada com sucessoNo 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