Primeiros passos
Para conseguir se conectar a API, siga os seguintes passos:
1. Vamos gerar o token no account:
Clique em novo token, de um nome para o seu token, exemplo "meu-api-token", depois clique em criar.
Clique no botão para copiar o token gerado.
2. Agora com o token criado, vamos autenticar na API:
Com o token criado, você pode realizar consultas através da API por uma linguagem de programação ou ferramenta de requisição, como Postman ou Insomnia. Mas você pode testar por aqui mesmo algumas requests com seu token, para ver tudo funcionado.
Clique no menu no item API e em seguida clique em Autorize.
Pegue o token que foi copiado e cole no campo value API e em seguida clique em Authorize.
Obs: não se esqueça de adicionar na frente do campo value a a palavra Bearer .
3. Vamos fazer a primeira consulta?
A maioria das consultas da API precisa do id da organização criado pelo App Umbler Talk, para descobrir qual o id da sua organização você pode fazer uma request para a rota "/me", que retorna uma lista das organizações que você pertence.
Vamos até a rota "/v1/member/me".
Clique no botão Try it out e em seguida clique em Execute.
4. Enviando mensagens
A API possui diversas rotas que possibilitam automatizar todas as ações que você consegue fazer manualmente pelo app, como exemplo vamos enviar uma mensagem.
Vamos até a rota "/v1/messages/simplified/".
Preencha os seguintes dados:
- ToPhone: o telefone com DDD que você quer enviar a mensagem
- FromPhone: o telefone com DDD que você tem um canal ativo
- OrganizationId: o id da organização
- Message: a mensagem que você quer enviar
- File: se quiser enviar um arquivo, é só clicar no botão e escolher o arquivo