Contactos SMS

nome

string · required

telefone

string · required

Destination phone number in the format accepted by the SMS service.

Criar contacto SMS › Responses

Contacto criado.

contactoId

integer

nome

string

telefone

string

Listar contactos SMS

GET

https://sms.izipay.ao

/api/Contactos/ListarContactos

Bearer (JWT)

Método e rota: GET /api/Contactos/ListarContactos. Retorna uma lista paginada de contactos do comerciante autenticado.

Listar contactos SMS › query Parameters

pageNumber

integer · min: 1

Page number.

Default: 1

pageSize

integer · min: 1

Number of records per page.

Default: 20

Listar contactos SMS › Responses

Contactos paginados.

SmsContactPage

pageNumber

integer

pageSize

integer

totalCount

integer

Obter contacto SMS por ID

GET

https://sms.izipay.ao

/api/Contactos/ObterContacto/{contactoId}

Bearer (JWT)

Método e rota: GET /api/Contactos/ObterContacto/{contactoId}. Consulta um contacto SMS pelo seu identificador.

Obter contacto SMS por ID › path Parameters

contactoId

integer · required

SMS contact identifier.

Obter contacto SMS por ID › Responses

Detalhes do contacto.

contactoId

integer

nome

string

telefone

string

Atualizar contacto SMS

PUT

https://sms.izipay.ao

/api/Contactos/AtualizarContacto/{contactoId}

Bearer (JWT)

Método e rota: PUT /api/Contactos/AtualizarContacto/{contactoId}. Atualiza o nome e o telefone de um contacto.

Atualizar contacto SMS › path Parameters

contactoId

integer · required

SMS contact identifier.

Atualizar contacto SMS › Request Body

nome

string · required

telefone

string · required

Destination phone number in the format accepted by the SMS service.

Atualizar contacto SMS › Responses

Contacto atualizado.

contactoId

integer

nome

string

telefone

string

Eliminar contacto SMS

DELETE

https://sms.izipay.ao

/api/Contactos/DeletarContacto/{contactoId}

Bearer (JWT)

Método e rota: DELETE /api/Contactos/DeletarContacto/{contactoId}. Elimina um contacto da conta do comerciante autenticado.

Eliminar contacto SMS › path Parameters

contactoId

integer · required

SMS contact identifier.

Eliminar contacto SMS › Responses

Contacto eliminado.

success

boolean

message

string

Criar lista de contactos

POST

https://sms.izipay.ao

/api/Contactos/criar-lista-com-contactos

Bearer (JWT)

Método e rota: POST /api/Contactos/criar-lista-com-contactos. Cria uma lista de contactos e associa contactos existentes através dos seus IDs.

Criar lista de contactos › Request Body

SmsContactListRequest

nome

string · required

contactoIds

integer[] · required

Criar lista de contactos › Responses

Lista de contactos criada.

listaDeContactoId

integer

nome

string

contactoIds

integer[]

totalContactos

integer

Listar listas de contactos

GET

https://sms.izipay.ao

/api/Contactos/ListarListasDeContactos

Bearer (JWT)

Método e rota: GET /api/Contactos/ListarListasDeContactos. Retorna uma lista paginada de listas de contactos SMS do comerciante autenticado.

Listar listas de contactos › query Parameters

pageNumber

integer · min: 1

Page number.

Default: 1

pageSize

integer · min: 1

Number of records per page.

Default: 20

Listar listas de contactos › Responses

Listas de contactos paginadas.

SmsContactListPage

pageNumber

integer

pageSize

integer

totalCount

integer

SmsContactList[]

Obter lista de contactos por ID

GET

https://sms.izipay.ao

/api/Contactos/ObterListaDeContactos/{listaId}

Bearer (JWT)

Método e rota: GET /api/Contactos/ObterListaDeContactos/{listaId}. Consulta uma lista de contactos e os contactos associados.

Obter lista de contactos por ID › path Parameters

listaId

integer · required

SMS contact list identifier.

Obter lista de contactos por ID › Responses

Detalhes da lista de contactos.

listaDeContactoId

integer

nome

string

contactoIds

integer[]

AddSmsContactToListRequest

totalContactos

integer

Adicionar contacto a lista

POST

https://sms.izipay.ao

/api/Contactos/AdicionarContactoALista

Bearer (JWT)

Método e rota: POST /api/Contactos/AdicionarContactoALista. Adiciona um contacto existente a uma lista de contactos SMS existente.

Adicionar contacto a lista › Request Body

contactoId

integer · required

listaId

integer · required

Adicionar contacto a lista › Responses

Contacto adicionado a lista.

success

boolean

message

string

Eliminar lista de contactos

DELETE

https://sms.izipay.ao

/api/Contactos/DeletarListaDeContactos/{listaId}

Bearer (JWT)

Método e rota: DELETE /api/Contactos/DeletarListaDeContactos/{listaId}. Elimina uma lista de contactos. Os contactos podem continuar disponíveis fora da lista eliminada.

Eliminar lista de contactos › path Parameters

listaId

integer · required

SMS contact list identifier.

Eliminar lista de contactos › Responses

Lista de contactos eliminada.

success

boolean

message

string

Templates SMS Envio SMS

API de Notificações SMS

Contactos SMS

Server

Download schema

Gerir contactos SMS e listas de contactos para envios em massa.

Criar contacto SMS

POST

https://sms.izipay.ao

/api/Contactos/CadastrarContacto

Bearer (JWT)

Método e rota: POST /api/Contactos/CadastrarContacto. Cria um contacto SMS para o comerciante autenticado.

Criar contacto SMS › Request Body

nome

string · required

telefone

string · required

Destination phone number in the format accepted by the SMS service.

Criar contacto SMS › Responses

Contacto criado.

contactoId

integer

nome

string

telefone

string

Listar contactos SMS

GET

https://sms.izipay.ao

/api/Contactos/ListarContactos

Bearer (JWT)

Método e rota: GET /api/Contactos/ListarContactos. Retorna uma lista paginada de contactos do comerciante autenticado.

Listar contactos SMS › query Parameters

pageNumber

integer · min: 1

Page number.

Default: 1

pageSize

integer · min: 1

Number of records per page.

Default: 20

Listar contactos SMS › Responses

Contactos paginados.

SmsContactPage

pageNumber

integer

pageSize

integer

totalCount

integer

Obter contacto SMS por ID

GET

https://sms.izipay.ao

/api/Contactos/ObterContacto/{contactoId}

Bearer (JWT)

Método e rota: GET /api/Contactos/ObterContacto/{contactoId}. Consulta um contacto SMS pelo seu identificador.

Obter contacto SMS por ID › path Parameters

contactoId

integer · required

SMS contact identifier.

Obter contacto SMS por ID › Responses

Detalhes do contacto.

contactoId

integer

nome

string

telefone

string

Atualizar contacto SMS

PUT

https://sms.izipay.ao

/api/Contactos/AtualizarContacto/{contactoId}

Bearer (JWT)

Método e rota: PUT /api/Contactos/AtualizarContacto/{contactoId}. Atualiza o nome e o telefone de um contacto.

Atualizar contacto SMS › path Parameters

contactoId

integer · required

SMS contact identifier.

Atualizar contacto SMS › Request Body

nome

string · required

telefone

string · required

Destination phone number in the format accepted by the SMS service.

Atualizar contacto SMS › Responses

Contacto atualizado.

contactoId

integer

nome

string

telefone

string

Eliminar contacto SMS

DELETE

https://sms.izipay.ao

/api/Contactos/DeletarContacto/{contactoId}

Bearer (JWT)

Método e rota: DELETE /api/Contactos/DeletarContacto/{contactoId}. Elimina um contacto da conta do comerciante autenticado.

Eliminar contacto SMS › path Parameters

contactoId

integer · required

SMS contact identifier.

Eliminar contacto SMS › Responses

Contacto eliminado.

success

boolean

message

string

Criar lista de contactos

POST

https://sms.izipay.ao

/api/Contactos/criar-lista-com-contactos

Bearer (JWT)

Método e rota: POST /api/Contactos/criar-lista-com-contactos. Cria uma lista de contactos e associa contactos existentes através dos seus IDs.

Criar lista de contactos › Request Body

SmsContactListRequest

nome

string · required

contactoIds

integer[] · required

Criar lista de contactos › Responses

Lista de contactos criada.

listaDeContactoId

integer

nome

string

contactoIds

integer[]

totalContactos

integer

Listar listas de contactos

GET

https://sms.izipay.ao

/api/Contactos/ListarListasDeContactos

Bearer (JWT)

Método e rota: GET /api/Contactos/ListarListasDeContactos. Retorna uma lista paginada de listas de contactos SMS do comerciante autenticado.

Listar listas de contactos › query Parameters

pageNumber

integer · min: 1

Page number.

Default: 1

pageSize

integer · min: 1

Number of records per page.

Default: 20

Listar listas de contactos › Responses

Listas de contactos paginadas.

SmsContactListPage

pageNumber

integer

pageSize

integer

totalCount

integer

SmsContactList[]

Obter lista de contactos por ID

GET

https://sms.izipay.ao

/api/Contactos/ObterListaDeContactos/{listaId}

Bearer (JWT)

Método e rota: GET /api/Contactos/ObterListaDeContactos/{listaId}. Consulta uma lista de contactos e os contactos associados.

Obter lista de contactos por ID › path Parameters

listaId

integer · required

SMS contact list identifier.

Obter lista de contactos por ID › Responses

Detalhes da lista de contactos.

listaDeContactoId

integer

nome

string

contactoIds

integer[]

AddSmsContactToListRequest

totalContactos

integer

Adicionar contacto a lista

POST

https://sms.izipay.ao

/api/Contactos/AdicionarContactoALista

Bearer (JWT)

Método e rota: POST /api/Contactos/AdicionarContactoALista. Adiciona um contacto existente a uma lista de contactos SMS existente.

Adicionar contacto a lista › Request Body

contactoId

integer · required

listaId

integer · required

Adicionar contacto a lista › Responses

Contacto adicionado a lista.

success

boolean

message

string

Eliminar lista de contactos

DELETE

https://sms.izipay.ao

/api/Contactos/DeletarListaDeContactos/{listaId}

Bearer (JWT)

Método e rota: DELETE /api/Contactos/DeletarListaDeContactos/{listaId}. Elimina uma lista de contactos. Os contactos podem continuar disponíveis fora da lista eliminada.

Eliminar lista de contactos › path Parameters

listaId

integer · required

SMS contact list identifier.

Eliminar lista de contactos › Responses

Lista de contactos eliminada.