Docy

Documentação da API

Estimated reading: 2 minutes 0 views

Exemplos de uso da API em cURL :

Get message POST

				
					curl --location --request POST 'https://apinew.socialhub.pro/api/getMessages'
--form 'api_token="SEU API_TOKEN AQUI"'
--form 'phone="NUMERO DO CONTATO"'
--form 'page="NUMERO DA PAGINA"' --form 'perPage="QUANTIDADE POR PAGINA"
				
			
Parâmetro ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎Descrição Tipo Text
api_token
Seu token gerado no momento da integração
string
Sim
phone
Número do contato que deseja obter as mensagens trocadas
string
Sim
Page
Número da página, puxa a primeira se não passado
Int
Não
perPage
Quantidade de registros por página, puxa 25 se não passado
Int
Não

Send message POST:

				
					curl --location --request POST 'https://apinew.socialhub.pro/api/sendMessage'
--form 'api_token="SEU API_TOKEN AQUI"'
--form 'phone="NUMERO DESTINO"'
--form 'file=@"DIRETÓRIO DO ARQUIVO"'
--form 'message="MENSAGEM"
				
			
Parâmetro ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎Descrição Text ‎ ‎ ‎ ‎ ‎ ‎‎ ‎ ‎ ‎ ‎ ‎‎ ‎ ‎ ‎ ‎ ‎‎ ‎ ‎ Obrigatório
api_token
Seu token gerado no momento da integração
string
Sim
phone
número do destinatário da mensagem
string
Sim
file
arquivo que será enviado ao destinatário.
file
Não
message
mensagem que será enviada ao destinatário
String
Apenas se não houver arquivos

Exemplos de retorno em caso de sucesso:

Send Message:

				
					status_code: 200
{
  "success": true,
  "data": [
    {
      "id": 12970849,
      "source": 0,
      "message": "Um áudio de teste",
      "message_id": "3EB0F8EF2DFCCE0577DC",
      "phonenumber": "55xx99999999",
      "contactphone": "55xx99999999",
      "type_id": 3,
      "path": "https://whatsmeowx.socialhub.pro/S4h_EPRZm-b46kyoUbUJ/getFile/55xx99999999/3EB0F8EF2DFCCE0577DC.mp3",
      "client_original_name": "",
      "created_at": "2022-08-29T11:36:41.86702-03:00"
    }
  ]
}
				
			
Send Message::
				
					status_code: 200 {"success":true,"message":"Message stored successfully. Will be processing in few seconds!"}
				
			
Exemplos de retorno em caso de Api_Token inválido:
				
					status_code: 400
{"success":false,"message":"invalid api_token!"}
				
			
 Exemplos de retorno na falta de qualquer outro parâmetro:
				
					status_code: 400
{"success":false,"message":"missing parameters!"} 
				
			
Compartilhe este artigo
Conteúdo