Telefones da pessoa física - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

Issue: https://github.com/BRAConsultoria/SocialAPI-v2/issues/42

Obtendo os telefones de uma pessoa física

Endpoint: /v1/pessoa-fisica/telefones/{pf_id}/

GET

Retorno:

{
   "success":true,
   "data":{
      "SocialAPI":{
         "current":[
            {
               "tel_id":"{id}",
               "tel_tipo":"F|M",
               "tel_ddi":55,
               "tel_ddd":81,
               "tel_prefixo":"99777",
               "tel_sufixo":"6667",
               "tel_verif":1,
               "tel_manual_verif":0,
               "tel_class": "C",
               "tel_obs": "(long text)",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            },
            {
               "tel_id":"{id}",
               "tel_tipo":"F|M",
               "tel_ddi":55,
               "tel_ddd":81,
               "tel_prefixo":"3011",
               "tel_sufixo":"0702",
               "tel_verif":0,
               "tel_manual_verif":0,
               "tel_class": "C",
               "tel_obs": "(long text)",
               "author":{
                  "oid":"{oid}",
                  "uupfid":"{uupfid}",
                  "nome":"Nome do autor",
                  "timestamp":123123
               }
            }
         ],
         "revisions":[
         ],
         "others":[
         ]
      }
   }
}

Forçando flush do cache

Endpoint /v1/pessoa-fisica/telefones/flush/{pf_id}/

GET

Retorno conforme este endpoint.

Inserindo um telefone

Endpoint: /v1/pessoa-fisica/telefones/

POST

Payload:

{
   "pf_id":"{id}",
   "tel_tipo":"F|M",
   "tel_ddi":55,
   "tel_ddd":81,
   "tel_prefixo":"99777",
   "tel_sufixo":"6667",
   "tel_class": "C", //R = Residencial, C = Celular, CO = Comercial, RC = Recado, RA = Ramal
   "tel_obs": "(long text)",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 201

Removendo um telefone

Endpoint: /v1/pessoa-fisica/telefones/{pf_id}/{tel_id}/

DELETE

Payload:

{
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Retorno:

Status code: 204


Requisitando disparo de código via SMS

Endpoint: /v1/pessoa-fisica/telefones/validate/{pf_id}/{tel_id}/

GET

Retorno:

Status code: 200

Confirmando o código recebido via SMS

Endpoint: /v1/pessoa-fisica/telefones/validate/

POST

Payload:

{
   "pf_id": "{pf_id}",
   "tel_id": "{tel_id}",
   "validate-code": "abcd123"
}

Retorno:

Status code: 202 (Aceito)

Validando manualmente um telefone, fixo ou celular

POST: /v1/pessoa-fisica/telefones/manual-validate/

{
   "pf_id": "{pf_id}",
   "tel_id": "{tel_id}",
   "device":{
      "id":"7df0723b4c86ab59711ea26c66642c47",
      "log":{
         "lat":"-7.9839111",
         "lon":"-34.8387671"
      }
   }
}

Status code: 202