curl --request POST \
--url https://api.notifique.dev/v1/chat/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "clxxapp...",
"to": [
"cnv_xxxxx"
],
"type": "text",
"payload": {
"message": "Hola Alice, tu pedido salió a entrega."
},
"senderExternalUserId": "agent:clxxuser...",
"clientMessageId": "msg_text_001"
}
'
{
"success": true,
"data": {
"id": "clxxmsg...",
"conversationId": "cnv_xxxxx",
"type": "TEXT",
"body": "Oi, Alice",
"createdAt": "2023-11-07T05:31:56Z",
"senderId": "<string>",
"mediaUrl": null,
"replyToId": "<string>",
"clientMessageId": "msg_text_001",
"deletedAt": "2023-11-07T05:31:56Z",
"sender": {
"id": "<string>",
"externalUserId": "user_alice",
"name": "<string>",
"kind": "USER"
}
},
"idempotent": true
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}Mensajes
Enviar mensaje
Mismo contrato PIV1 que los otros canales: from (Chat App), to (id de la conversación), type y payload. Con API Key, senderExternalUserId es obligatorio. Alcance: chat:messages:send. 1 crédito CHAT_MESSAGE.
POST
/
v1
/
chat
/
messages
curl --request POST \
--url https://api.notifique.dev/v1/chat/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "clxxapp...",
"to": [
"cnv_xxxxx"
],
"type": "text",
"payload": {
"message": "Hola Alice, tu pedido salió a entrega."
},
"senderExternalUserId": "agent:clxxuser...",
"clientMessageId": "msg_text_001"
}
'
{
"success": true,
"data": {
"id": "clxxmsg...",
"conversationId": "cnv_xxxxx",
"type": "TEXT",
"body": "Oi, Alice",
"createdAt": "2023-11-07T05:31:56Z",
"senderId": "<string>",
"mediaUrl": null,
"replyToId": "<string>",
"clientMessageId": "msg_text_001",
"deletedAt": "2023-11-07T05:31:56Z",
"sender": {
"id": "<string>",
"externalUserId": "user_alice",
"name": "<string>",
"kind": "USER"
}
},
"idempotent": true
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"message": "<string>"
}Autorizaciones
ntfChatBearerAuthntfChatApiKeyHeader
API Key sk_live_… / sk_test_… ou JWT do usuário do chat (eyJ…).
Cuerpo
application/json
Id del Chat App. Si se informa, debe coincidir con la conversación.
Ejemplo:
"clxxapp..."
Id de la conversación (string o lista).
Ejemplo:
"cnv_xxxxx"
Opciones disponibles:
text, image, audio, file Ejemplo:
"text"
Contenido PIV1. Texto en message; media en mediaUrl (HTTPS).
Show child attributes
Show child attributes
Obligatorio con API Key. externalUserId de USER o AGENT.
Ejemplo:
"user_alice"
Ejemplo:
"msg_001"
Legado. Prefiera payload.message.
Legado. Prefiera payload.mediaUrl.
¿Esta página le ayudó?