Caso de Uso - Criação de Assinantes
Neste caso de uso, vamos abordar o fluxo recomendado para a criação automatizada de um assinante.
Seguiremos o fluxo destacando as principais APIs necessárias para implementar esse processo.
Para criar um assinante/conta, é necessário preencher os dados presentes no Softswitch SipPulse, como domínio (domain
), perfil (profile
) e plano de tarifas (rateplan
).
Este caso de uso deve ser utilizado em conjunto com o manual de integração da versão correspondente.
Listagem de Domínios - Domain
Neste passo, utiliza-se a API de listagem de domínios para obter o objeto Domain
, cujo campo domain
será usado para preencher o campo correspondente. Esse objeto também será utilizado nas duas listagens seguintes.
Documentação da API SOAP para as versões:
Integração - PCRT 5.7 | DomainWS Listar Domínios
Integração - PCRT 5.6.1 | DomainWS Listar Domínios
Integração - PCRT 5.0 / PCRT 5.1 / PCRT 5.2 | DomainWS Listar Domínios
Integração - PCRT 4.7 | DomainWS Listar Domínios
Listagem de Profiles - Profile
Neste passo, utiliza-se a API de listagem de perfis com o domínio selecionado no primeiro passo para extrair o objeto Profile
. O campo nome desse objeto será usado para preencher o campo profile
.
Documentação da API SOAP para as versões:
Integração - PCRT 5.7 | ProfileWS Listar Profiles por Domínio
Integração - PCRT 5.6.1 | ProfileWS Listar Profiles por Domínio
Integração - PCRT 5.0 / PCRT 5.1 / PCRT 5.2 | ProfileWS Listar Profiles por Domínio
Integração - PCRT 4.7 | ProfileWS Listar Profiles por Domínio
Listagem de Planos de Tarifa - RatePlan
Neste passo, utiliza-se a API de listagem de planos de tarifa com o domínio selecionado no primeiro passo para extrair o objeto RatePlan
. O ID desse objeto será utilizado para preencher o campo ratePlanId
durante a criação do assinante.
Documentação da API SOAP para as versões:
Integração - PCRT 5.7 | RatePlanWS Listar Plano de Tarifas por Domínio
Integração - PCRT 5.6.1 | RatePlanWS Listar Plano de Tarifas por Domínio
Integração - PCRT 5.0 / PCRT 5.1 / PCRT 5.2 | RatePlanWS Listar Plano de Tarifas por Domínio
Integração - PCRT 4.7 | RatePlanWS Listar Plano de Tarifas por Domínio
Criação/Edição de Assinante - Subscriber
Nesta etapa final do fluxo, todos os dados coletados anteriormente serão utilizados para a criação ou edição de um assinante. Para a criação, será utilizado um endpoint específico, e para a edição, outro.
Documentação da API SOAP para as versões:
Criação:
Integração - PCRT 5.7 | SubscriberWS Incluir Novos Assinantes
Integração - PCRT 5.6.1 | SubscriberWS Incluir Novos Assinantes
Integração - PCRT 5.0 / PCRT 5.1 / PCRT 5.2 | SubscriberWS Incluir Novos Assinantes
Edição:
Criação de DID(Opcional):
Esta etapa, que é opcional, permite a criação de um DID, ou seja, um alias para o assinante, caso o número para recebimento de chamadas seja diferente do login (username
) utilizado na criação do assinante.
Documentação da API SOAP para as versões:
SIPPulse Routing and Billing Solutions for SIP