# pointer-play-api



## Sample Request

```json

{

"cpf":  "22218435845",

"reference":  "abc123",

"numbers": [ "11999762024" ],

"vars": {

"@PrimeiroNome":  "guilherme"

},

"campaignId":  70

}



```



## Sample Response

```json

{

"success":  true,

"contactId":"65a81642-c67e-4aa0-970c-1abed71e2cf3"

}



```



# API Autenticação



Para realizar uma chamada via API (`POST`), você precisa se autenticar passando em sua requisição no `authorization` do tipo `Basic Auth` as seguintes credenciais.

```


"basic": {
	"username": "slug",

	"password": "apikey"
}

```

# API: Descrição Body

As informações necessárias no corpo da requsição devem manter a seguinte estrutura de informações:



* Requisição `POST`



Exemplo de Requisição `POST` na rota `/call` passando os parâmetros via `application/json` no corpo da requisição.



* rota:



```json



host:8081/call



```



* corpo:



```json



{

	"aggregatorName":"Teste 1"

	"campaignId": 1

	"reference": "abc123",

	"numbers": [ "11123112323" ],

	"cpf": "12345678910",

	"vars": [

		{

		"type" : "string",

		"key" : "@PrimeiroNome",

		"value" : "ZENAIDE"

		},

		{

		"type" : "string",

		"key" : "@NomeCompleto",

		"value" : "JOAO DA SILVA"

		},

		{

		"type" : "number",

		"key" : "@ParcelValue",

		"value" : 101.36

		}
	]
}



```

Respeitar sempre as tipagens de cada propriedade. A seguir breve descritivo de cada propriedade.

Propriedade `CPF` precisa ser passado o identificador do cliente de preferência (sem máscara).

Propriedade `aggregatorName` é responsável por agrupar todas as discagens feitas para aquele agregador. Caso não exista, por default será agrupado no seguinte padrão referente a data de discagem `2019-09-01`. Informação posteriormente exibida na plataforma e relatórios.

Propriedade `reference` é utilizada para apenas para alguns fins de relatórios ou configurações específicas do cliente. Não obrigatório.

Propriedade `numbers` necessita de ser um array de string com N números de telefone.

Propriedade `vars` necessita de ser um array de objetos com N posições onde deve ser seguido o exemplo acima, respeitando as necessidades de cada àrvore e tipagens de cada informação. Obrigatoriamente deve ser passado minimamente as informações @PrimeiroNome e @NomeCompleto.

A propriedade `campaignId` deve ser passado o id da campanha em que deseja realizar a discagem, tipo Inteiro.


# API: Resposta

Ao término de uma discagem a API retornará o callback com um objeto que possue a chave `sucess` com valor `true` indicando sucesso e outra propriedade chamada `contactId` com o identificador único de cada contato discado.
Em caso de erro será retornado um objeto com a mensagem do erro detalhado.
* exemplo de resposta com sucesso:
```json
{

	"success": true,

	"contactId":"65a81642-c67e-4aa0-970c-1abed71e2cf3"
}

```