Ir para o conteúdo

Solicitações de nomes alfa

Rotas de API para criar e listar nomes Alpha (nomes comerciais verificados usados como remetente de mensagens).

1. Criar nome alfa da organização

Esta solicitação POST é usada para criar um novo Nome Alfa associado a uma organização. A solicitação requer uma chave de autorização da organização nos cabeçalhos.

Solicitação - URL: https://restapi.smsbat.com/organizations/alpha_name - Método: POSTAR - Cabeçalhos: - Aceitar: aplicação/json - X-Authorization-Key: {organization_token} (Criado na seção Perfil do usuário).

Corpo: 

{
  "name": "testName",
  "companyCode": "88888888"
}

Parâmetros corporais: 1. name (String): O nome alfa proposto. - Requisito: O comprimento deve ser inferior a 12 caracteres. 2. companyCode (String): O código de registro da empresa associado ao Alphaname (ERPOU/IPN para a Ucrânia).

Possíveis respostas: - 200 OK: Alpha Name foi enviado com sucesso para moderação/criação. - 400 Bad Request: Erro de validação (por exemplo, o nome é muito longo). - 401 Não autorizado: X-Authorization-Key inválido ou ausente.

2. Buscar lista AlphaName

Recupera uma lista atualizada de nomes alfa, incluindo seus status atuais de moderação.

Solicitação - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Método: OBTER - Cabeçalhos: - X-chave de autorização: {organization_token}

Resposta (200 OK): 

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

Status de nomes alfa (statusCode): - PA - Aprovação pendente - A - Aprovado - D - Recusado