RCS
A API RCS da seven oferece a possibilidade de integrar as poderosas funcionalidades do RCS em sua aplicação, permitindo uma comunicação rica e interativa com seus usuários. Esta documentação descreve detalhadamente os diversos endpoints, parâmetros e funcionalidades da API RCS. Descubra as diversas possibilidades que o RCS oferece para melhorar mensagens, troca de arquivos, compartilhamento de localização e muito mais.
Para o envio de mensagens RCS, é obrigatória a inscrição de um chamado Agente em cada operadora para a qual você deseja enviar mensagens RCS. O Agente é, por assim dizer, o remetente verificado do RCS e é projetado em seu CI.
- 1
Registrar agentes
O processo de registro atualmente só pode ser realizado manualmente. Envie o formulário em nossa página de produto RCS para começar a usar o RCS. Em seguida, entraremos em contato imediatamente para solicitar alguns dados para a configuração do agente.
- 2
Integrar API RCS
Depois que seu agente estiver configurado, você pode começar diretamente a implementação da API.
- 3
Testar RCS
Verifique sua integração minuciosamente. Neste momento, você só pode usar os números de teste registrados para o agente.
- 4
Solicitar aprovação
Assim que você tiver implementado o RCS e testado de forma suficiente e bem-sucedida, podemos solicitar a aprovação do agente nas operadoras desejadas. Este processo geralmente leva alguns dias úteis e frequentemente está associado a perguntas adicionais.
- 5
Enviar RCS 🚀
Você está pronto para começar a enviar mensagens RCS!
Enviar RCS
Este endpoint permite o envio de mensagens RCS para usuários. Antes de enviar um RCS, você deve idealmente consultar as capacidades do número para garantir a melhor experiência do usuário.
Parâmetros
- Name
to- Type
- string
- Description
O número de telefone do destinatário para sua mensagem RCS. Isso também pode ser um nome de contato ou nome de grupo.
- Name
text- Type
- string
- Description
Texto da mensagem RCS. Para enviar uma mensagem RCS simples (sem imagens, respostas sugeridas, etc.), forneça apenas o texto puro da mensagem aqui. Caso contrário, use um objeto RCS.
- Name
from- Type
- string
- Optional
- Optional
- Description
O ID exclusivo do seu agente. Você pode visualizá-lo nas Configurações da sua conta. Se não especificado, o primeiro remetente compatível com RCS será usado.
- Name
delay- Type
- timestamp
- Optional
- Optional
- Description
Data/hora para envio programado. Opcionalmente, Unix-Timestamp ou um timestamp no formato yyyy-mm-dd hh:ii.
- Name
ttl- Type
- integer
- Optional
- Optional
- Description
Indica a duração de validade do RCS em minutos. O padrão é 2880, ou seja, 48 horas.
- Name
label- Type
- string
- Optional
- Optional
- Description
Opcionalmente, defina um rótulo para cada SMS para poder classificá-los em suas estatísticas. Máx. 100 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
- Name
performance_tracking- Type
- boolean
- Optional
- Optional
- Description
Ativar rastreamento de cliques e desempenho para URLs encontradas no texto do SMS. Isso também ativa o encurtador de URL.
- Name
foreign_id- Type
- string
- Optional
- Optional
- Description
Forneça seu próprio ID para esta mensagem. Você receberá o foreign_id de volta em callbacks para relatórios de status, etc. Máx. 64 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
- Name
fallback- Type
- enum | object
- Optional
- Optional
- Description
Se o envio de RCS não for possível, por exemplo, porque o dispositivo do destinatário não suporta RCS, a mensagem pode ser enviada automaticamente por um canal alternativo. Se nenhum fallback for especificado, ele estará desativado.
Envie um destes valores:
sms - Envia um SMS com o texto da mensagem RCS como conteúdo webview - Envia um SMS com um link para uma visualização web da mensagem RCS
Ou envie um objeto JSON:
{ "type": "sms", "text": "Hier ist der Text der SMS", "from": "Absender" }
curl -X POST "https://gateway.seven.io/api/rcs/messages" \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-d "text=Hello World!" \
-d "to=49176123456789"
{
"success": "100",
"total_price": null,
"balance": 3218.988,
"debug": "false",
"sms_type": "direct",
"messages": [
{
"id": "77233319353",
"sender": "myfancyagent",
"recipient": "49176123456789",
"text": "Hello World!",
"encoding": "gsm",
"label": null,
"parts": 0,
"udh": null,
"is_binary": false,
"price": 0,
"channel": "RCS",
"success": true,
"error": null,
"error_text": null
},
{
"id": "77233319354",
// ...
}
]
}
Excluir RCS
Você pode revogar uma mensagem RCS que ainda não foi entregue. Esta API retorna imediatamente uma resposta de sucesso, independentemente de a mensagem ter sido excluída ou não. Uma revogação só é possível se o dispositivo final tiver a capacidade REVOCATION.
Parâmetros de Caminho
- Name
ID da Mensagem- Type
- string
- Description
O ID da mensagem que deve ser excluída.
Requisição
curl -X DELETE "https://gateway.seven.io/api/rcs/messages/123456" \
-H "X-Api-Key: SUA_CHAVE_API"
Resposta
{
"success": true
}
Eventos
Envie um evento para um número de telefone para oferecer aos usuários uma experiência de conversa mais autêntica. Após receber uma mensagem, você deve enviar o evento READ em tempo hábil e, em seguida, IS_TYPING conforme apropriado.
Parâmetros
- Name
to- Type
- string Union
- Description
O número de telefone para o qual você deseja enviar o evento.
- Name
msg_id- Type
- string Union
- Description
O ID do RCS recebido para o qual você deseja enviar o evento.
- Name
event- Type
- enum
- Description
O evento que deve ser enviado. Pode ter um dos seguintes valores:
Mostrar eventos
IS_TYPING- O agente está digitandoREAD- A mensagem enviada pelo usuário foi lida
Solicitação
curl -X POST "https://gateway.seven.io/api/rcs/events" \
-H "X-Api-Key: IHR_API_SCHLÜSSEL" \
-d "to=49176123456789" \
-d "event=IS_TYPING" \
-d "from=myfancyagent"
Resposta
{
"success": true
}