Documentación de la API de socios Grizzly SMS

Description of the protocol's operation

El protocolo de socios está diseñado para proporcionar números de teléfono y mensajes SMS entrantes a través de API directamente al servidor Grizzly SMS. 

Todas las solicitudes incluyen la CLAVE de parámetro. Esta clave es proporcionada por el personal de soporte y está disponible en la cuenta personal.

Solicitudes de cantidad GET_SERVICIOS, solicitudes de números GET_NUMBER y solicitudes de finalización de activación FINISH_ACTIVACIÓN se envían directamente desde nuestro servidor al servidor del socio.

Formato de URL : https://GrizzlySMS donde pueden estar los GrizzlySMS partner.ru:port/GrizzlySMS.php o partner.ru/GrizzlySMS.php

GET_SERVICIOS

GET_NUMBER

PUSH_SMS

FINISH_ACTIVACIÓN

El servidor de SMS Grizzly envía una solicitud de cantidad de números de teléfono utilizando el GET_SERVICIOS método aproximadamente cada 10-20 segundos.

Si proporciona un recuento > 0 en respuesta, recibirá una solicitud de emisión de un número de teléfono utilizando el GET_NUMBER método.

Después de recibir el GET_NUMBER solicitud, debe proporcionar un 
número de teléfono que cumpla con todos los criterios y reenvíenos todos los mensajes SMS entrantes utilizando el PUSH_SMS método. Esto es necesario para que podamos realizar un filtrado claro y objetivo y entregar los mensajes SMS relevantes al servicio adecuado para nuestros clientes.

Al completar todas las tareas necesarias relacionadas con los números de teléfono, recibirá un estado 3 a través del FINISH_ACTIVACIÓN método. Este estado indica que el número de teléfono se registró correctamente y que ha sido recompensado por ello.

Requisitos:

  • Formato de solicitud/respuesta: JSON
  • Codificación UTF-8
  • Utilice siempre un encabezado de agente de usuario en las solicitudes al servidor Grizzly SMS

 

Tipos de campo:

  • int: valor entero en el rango de -2 147 483 648 a 2 147 483 647
  • Uint: valor entero sin signo en el rango de 0 a 2 147 483 647
  • long: valor entero en el rango de -9 223 372 036 854 775 808 a 9 223 372 036 854 775 807
  • Ulong: valor entero largo sin signo en el rango de 0 a 9 223 372 036 854 775 80
  • cur: valor real que contiene hasta 2 decimales, por ejemplo, 177.77
  • booleano: valores literales verdadero o falso
  • string: valor de cadena de longitud ilimitada
  • matriz de cadena: cadena masiva
1. GET_SERVICES number request method

Esta solicitud nos proporciona información sobre la cantidad de números de teléfono para servicios disponibles para la venta.

La solicitud POST se transmite desde el servidor Grizzly SMS al servidor del socio.

! Tenga en cuenta: Si su módem GSM tiene un número limitado de módulos activos simultáneamente, debe proporcionar un recuento igual al número de módulos activos.

Campos de solicitud
Campo Tipo Requerido Descripción
acción Cuerda
 
GET_SERVICIOS
clave Cuerda
 
Clave de protocolo
Campos de respuesta:
Campo Tipo Requerido Descripción
estado Cuerda
 
Estado de la respuesta (см. Tabla de Estado)
Lista de Paisanos Matriz de CountryList
 
Lista de países
 
CountryList
Campo Tipo Requerido Descripción
país Cuerda
 
(ver Tabla de Datos)
Mapa Operativo* Asociativo
matriz
 
Operador de teclas (ver Tabla de Datos), matriz de servicios asociativos de valor**

* No debe enviar matrices de datos vacías en el mapa de operaciones

** Matriz asociativa de servicios: Clave: un breve nombre de servicio( consulte la Tabla de datos), valor: la cantidad de números de teléfono disponibles para el servicio (tipo: int)

Ejemplo de una solicitud:
{
  "action": "GET_SERVICIOS",
  "key": "qwerty123"
}
Ejemplo de una respuesta:
{
  "countryList":
    [
      {
        "country": "russia",
        "operatorMap":
          {
            "any":
              {
                "vk": 3,
                "ok": 10
              }
          }
      },
      {
        "country": "ukraine",
        "operatorMap":
          {
            "any":
              {
                "vk": 0,
                "wa": 32
              }
          }
      }
    ],
  "status": "SUCCESS"
}
2. GET_NUMBER request method

Esta solicitud nos proporciona un número de teléfono que transmitimos al cliente.

La solicitud POST se transmite desde el servidor Grizzly SMS al servidor del socio.

Si la matriz exceptionPhoneSet contiene una lista de prefijos, por ejemplo, 44742 y 44740, no debe proporcionar un número que comience con ninguno de estos prefijos. El número de dígitos no está limitado por el tamaño del prefijo.

Campos de solicitud:
Campo Tipo Requerido Descripción
acción Cuerda
 
GET_NUMBER
clave Cuerda
 
Clave de protocolo
país Cuerda
 
ver Tabla de Datos
servicio Cuerda
 
ver  Tabla de Datos
operador Cuerda
 
ver  Tabla de Datos
suma Cur
 
La cantidad que recibirá por un servicio registrado correctamente
Excepciónteléfonos Matriz de Cadena
 
Lista de prefijos que ESTÁ PROHIBIDO dar al solicitar un número de teléfono
Answer fields
Field Tipo Requerido Descripción
status Cuerda
 
(ver Tabla de Estado)
number Ulong
 
Número de teléfono con código de país
activationId Ulong
 
ID de activación en el sistema del socio
 
Ejemplo de una solicitud:
{
  "action": "GET_NUMBER",
  "key": "qwerty123",
  "country": "russia",
  "operator": "any",
  "service": "tg",
  "sum": 20.00,
}
Example of a request with exceptionPhoneSet
{
  "action": "GET_NUMBER",
  "key": "qwerty123",
  "country": "russia",
  "operator": "any",
  "service": "vk",
  "sum": 10,
  "exceptionPhoneSet": [
    "7918",
    "79281"
  ]
}
Ejemplo de una respuesta:
{
  "status": "SUCCESS",
  "number": 79157891133,
  "activationId": 571346
}
Ejemplo de respuesta en caso de ausencia de números:
{
  "status": "NO_NUMBERS"
}
3. Delivery of SMS to the Grizzly SMS server using the PUSH_SMS method

Esta solicitud POST se envía desde el servidor del socio al servidor Grizzly SMS en la dirección:  https://api.grizzlysms.com/agent/api/sms

Si recibe una respuesta con el estado "CORRECTO", marque el SMS como entregado correctamente en su base de datos y no lo vuelva a enviar. Si se devuelve un estado que no sea "CORRECTO", repita la solicitud con un retraso de 10 segundos hasta que reciba un estado de" CORRECTO".

Campos de solicitudes
Campo Tipo Requerido Descripción
acción Cuerda
 
PUSH_SMS
clave Cuerda
 
Clave de protocolo
smsId Ulong
 
ID de SMS en el sistema de socios
teléfono Ulong
 
Número de teléfono (incluido el código del condado) al que se envió el SMS
Teléfonodesde Cuerda
 
El nombre del remitente (puede ser alfanumérico o numérico) que envió el SMS
Texto Cuerda
 
Texto SMS
Состав полей ОТВЕТА
Campo Tipo Requerido Descripción
estado Cuerda
 
(ver  Tabla de Estado)
Example of a request:
{
  "action": "PUSH_SMS",
  "key": "qwerty123",
  "smsID": 1
  "phone": 447472190082
  "phoneFrom": "Microsoft",
  "text": "Microsoft access code: 5015"
}
Ejemplo de una respuesta:
{
  "status": "SUCCESS"
}
4. Activation completion request method FINISH_ACTIVATION

Esta solicitud se transmite desde el servidor Grizzly SMS al servidor del socio para completar la activación.

Solicitud POST iniciada desde el servidor de SMS Grizzly al servidor del socio.

La gestión de la activación está totalmente controlada por Grizzly SMS. Debido a factores fuera de nuestro control, es posible que no recibamos una respuesta suya con respecto a un cambio de estado exitoso. Por lo tanto, si Grizzly SMS envía una solicitud repetida de finalización de la activación, debe verificar la existencia del ID de activación en su extremo. Si la activación existe, envíe un estado de ÉXITO en respuesta.

Request fields
Field Type Required Desciption
action String
 
FINISH_ACTIVATION
key String
 
Protocol key
activationId Ulong
 
Activation ID obtained in the second request
status Ulong
 
See Status Table
Answer fields
Field Type Required Desctiption

status

String
 
See Status Table
Example of a request:
{
  "action": "FINISH_ACTIVATION",
  "key": "qwerty123",
  "smsId": 100,
  "status": 3
}
Example of an answer:
{
  "status": "SUCCESS"
}
Testing the protocol

Simultaneous Number Issuance. You should handle simultaneous requests properly and not issue numbers repeatedly. For example, if you have 100 numbers for Telegram Indonesia, and Grizzly SMS simultaneously makes 100 requests for Telegram United Kingdom, the partner server should provide 100 unique numbers. If a number is issued multiple times, the test fails.

Crrect Activation Completion. The change in activation status is fully controlled by Grizzly SMS. The partner server should not autonomously complete activations.

SMS Delivery Verification. Once you receive an SMS, you must immediately forward it to the Grizzly SMS server. If you receive a status of SUCCESS, you should not forward the SMS again. However, if you receive a different status, you should retry the request every 10-20 seconds. If an SMS is issued again after receiving a SUCCESS status, the test fails.

Field Type Verification. Thoroughly check the field types specified in this documentation. If this condition is violated, the testing fails.

 

Country Code in Phone Number. Phone number issuance should be in digital format and include the country code.

Number Issuance Time Verification. You must issue numbers with a delay of less than 3 seconds. If it takes more than 3 seconds, the testing fails.

Number Quantity Verification. If you issue 1000 numbers in a request for quantity of numbers, but only 100 are issued at the same time, then testing has failed.

Exception Handling Verification. If you incorrectly handle exceptions for issuing a number, then testing has failed.

Status Table
Состав полей ЗАПРОСА
Status Description
SUCCESS The request was finished successfully
ERROR Error during request execution. The ERROR field should be filled with a description
NO_NUMBERS No numbers are available. This response is only returned for a number request
Activation Status
Status Desctiption

1

Issuing a number for this service is prohibited
3 Activation was successfully sold. You have received a reward
4 Activation was canceled*
5 Activation has been returned. The customer has been refunded for the activation. It's possible that this number was previously registered, and two-factor authentication may be enabled on the number

**The mechanism for cancellation works as follows: If a phone number has been canceled 5 times,  you should not issue the same number again. It's possible that the number was not suitable for the client or was already registered for the  specific service.

Successful answer to the request:
{
  "status": "SUCCESS",
  //information
}
Answer in case of an error:
{
  "status": "ERROR",
 "error": "Description of the error"
}
Data Table
Data Table:
Lists Links
List of countries The full list of countries with names and IDs can be found at the link https://grizzlysms.com/docs
List of operators At the moment, the breakdown by operators is under development, so you should pass the value 'any'. Once this functionality is implemented, we will notify you through the technical support chat.
List of services The full list of services with names and IDs can be found at the link https://grizzlysms.com/docs
API for price change

This API is aimed at automatization of work with the sliders on your side (services’ prices).

API can be found by this address https://apiagent.7grizzlysms.com.
For authentication in requests you need to send your API-key in the HTTP-header apikey.

All data is transmitted in the JSON format.
As for GET requests, it is necessary to send HTTP-header Accept: application/json, as for POST request - Accept: application/json and Content-Type: application/json.

Available values of the country parameter are located in Country list in the columns ID and Countries, so, you can use both 0, and russia.
Available values of the service parameter are located in List of services in the column ID.

Terms and fines

Withdrawal founds. Withdrawal of earned funds is carried out by requests. A partner can create a request in the Withdrawal section. Withdrawal of earnings from 100 USDT is available for one transaction. Requests are processed daily from 8:00 to 20:00 (UTC) within 20 to 180 minutes. If you are promised any bonus (according to the terms and conditions published on the website), please be sure to indicate it in the comments to the request.

Compensations for 2FA and Wrong code. Grizzly SMS platform, as an intermediary, compensates customers for Telegram numbers with 2FA and wrong codes in full. Grizzly SMS receives information on 2FA automatically from Telegram Expert and TG-GIANT software. Important: Funds for numbers with 2FA and wrong code (answer 'wrong code') and on Telegram accounts are not charged. You can see the information about 2FA or wronge_code in the Activation History.