SMS-MT API HTTP GET

Versão: 2.00 – obsoleta Última Atualização: 04/03/2015

Índice

1. Introdução
2. Enviando mensagens via SMS (Envia SMS)
3. Obtendo o saldo de créditos em conta
4. Consultando envios realizados em um determinado período
5. Enviando mensagens via SMS (SMS Follow)
6. Obtendo o status de mensagens enviadas

1. Introdução

Seguindo a documentação presente nesta página, você irá conseguir integrar o seu sistema com o Gateway SMS do PitchWink! Para começar de pé direito, sugerimos que você leia os requerimentos, as notas importantes (onde comunicamos novidades e mudanças futuras) e as descrições de cada método. Desta forma, você irá ganhar tempo e conhecer a solução como um todo. Em caso de dúvida, estamos aqui para ajudá-lo! Acesse sua conta, crie um ticket de suporte e entre em contato conosco. Divirta-se integrando!

1.1. Requerimentos

É necessário ter acesso a “Credencial” da sua conta para realizar a integração. Estes dados podem ser encontrados no menu de “Configurações”, opção “Dados de Integração”. Sugerimos que você também aproveite para adicionar o “Remetente do SMS”, o mesmo irá ajudar seus destinatários a saberem quem é o remetente da mensagens enviadas a eles.

1.2. Notas importantes

Esta versão está obsoleta. Por favor utilize a nova versão do HTTP GET.

2. Enviando mensagens via SMS (Envia SMS)

O EnviaSMS é o método que permite o envio de mensagens via SMS através do nosso Gateway. Mensagens com até 160 caracteres podem ser enviadas para qualquer país que o PitchWink possui cobertura. Caso deseje obter o ID da mensagem para saber o status de envio, utilize ao invés deste método, o método SMSFollow.

2.1. Parâmetros do EnviaSMS

2.2. Retornos do EnviaSMS

2.3. Chamada (HTTP ou HTTPS)

https://www.pw-api.com/v_2_00/smspush/enviasms.aspx?Credencial=XXXX110B1B8723382XXXX793A74B5BC08D12266E&Principal_User=FF&Aux_User=F1&Mobile=552194797025&Send_Project=S&Message=teste

2.4. Exemplos do EnviaSMS

v_st_HTTPGET = "https://www.pw-api.com/v_2_00/smspush/enviasms.aspx"
v_st_Parametros = "?" & _
"CREDENCIAL=" & Server.UrlEncode("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX") & _
"&PRINCIPAL_USER=" & Server.UrlEncode("MP") & _
"&AUX_USER=" & Server.UrlEncode("USUÁRIOAUX") & _
"&MOBILE=" & Server.UrlEncode("5521999999999") & _
"&SEND_PROJECT=" & Server.UrlEncode("S") & _
"&MESSAGE=" & Server.UrlEncode("Mensagem de Teste")
' Montagem da URL de chamada
v_st_HTTPGET &= v_st_Parametros
Dim v_obj_Request As System.Net.HttpWebRequest = _
DirectCast(System.Net.WebRequest.Create(v_st_HTTPGET), _
System.Net.HttpWebRequest)
Dim v_st_Cod_Retorno As String
Dim v_obj_Response As System.Net.WebResponse = _
v_obj_Request.GetResponse()
If Not IsNothing(v_obj_Response) Then
Dim v_obj_IOStream As New _
System.IO.StreamReader(v_obj_Response.GetResponseStream())
v_st_Cod_Retorno = v_obj_IOStream.ReadToEnd()
v_obj_IOStream.Close()
' Retorna o v_st_Cod_Retorno no formato: 999
If v_st_Cod_Retorno.Equals("000") Then
' Mensagem enviada ao PitchWink com sucesso
Else
' Tratar o resultado de acordo com a tabela
' de Códigos de Retorno do PitchWink
End If
Else
' Algum erro na chamada HTTP GET
End If

3. Obtendo o saldo de créditos em conta

O método Credits serve para consultar o número de créditos disponíveis em sua conta.

3.1. Parâmetros do Credits

3.2. Retornos do Credits

3.3. Chamada (HTTP ou HTTPS)

http://www.pw-api.com/v_2_00/smscredits/credits.aspx?Credencial=XXXXXXXXXXYYYYYYYYYYXXXXXXXXXXYYYYYYYYYY

4. Consultando envios realizados em um determinado período

O método Query01 é utilizado para consultar as mensagens de texto SMS enviadas através da sua conta em um determinado intervalo de tempo.

4.1. Parâmetros do Query01

4.2. Retornos do Query01

4.3. Chamada (HTTP ou HTTPS)

http://www.pw-api.com/v_2_00/query01/query01.aspx?Credencial=XXXMU10B1B8SED382FXXX793A74B5BC08D12266E&Start_Date=01/09/2010&End_Date=05/09/2010&Aux_User=F1&Mobile=552199999999&Status_Code=1

5. Enviando mensagens via SMS (SMS Follow)

O método SMSFollow tem a mesma funcionalidade do EnviaSMS. A diferença é no retorno, onde vem também o ID da mensagem. Este ID vai ser utilizado no método Status de forma a obter o status de uma mensagem enviada.

5.1. Parâmetros do SMSFollow

5.2. Retornos do SMSFollow

5.3. Chamada (HTTP ou HTTPS)

https://www.pw-api.com/v_2_00/smsfollow/smsfollow.aspx?Credencial=XXXX110B1B8723382XXXX793A74B5BC08D12266E&Principal_User=FF&Aux_User=F1&Mobile=552194797025&Send_Project=S&Message=teste

6. Obtendo o status de mensagens enviadas

O método Status permite obter a condição atual da mensagem.

6.1. Parâmetros do Status

6.2. Retornos do Status

6.3. Chamada (HTTP ou HTTPS)

http://www.pw-api.com/v_2_00/smsstatus/status.aspx?Credencial=XXXXXXXXXX7737FA5D81XX1C2BFDDBEB7F1D7584&ID=XXXXXXXXXXCCCCCCCCCCYYYYYYYYYYUUUUUUUUUU