Contatti Rubrica

Cerca Contatti

Cerca i contatti

Richiesta

Se nella richiesta non viene specificato alcun parametro il servizio restituirà un elenco paginato di tutti i contatti presenti in rubrica.

Risposta

HTTP Status Code

La chiamata ritorna una lista con di contatti presenti in rubrica.

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.amm.cloud/sms/v2/phonebook/contact/search?name=Mario

{
   "metadata":{
      "count":1,
      "offset":0,
      "limit":20
   },
   "contacts":[
      {
         "id": 12345678,
         "msisdn":"393480000000",
         "name":"Mario",
         "lastname":"Rossi",
         "email":"mario.rossi@fake.it",
         "groups":[
            {
               "id":13197,
               "name":"Amici"
            },
            {
               "id":1947,
               "name":"Lavoro"
            }
         ],
         "customFields":[
            {
               "fieldKey": "f_indirizzo",
               "fieldName": "Indirizzo",
               "fieldValue": "via roma 1"
            },
            {
               "fieldKey": "f_cap",
               "fieldName": "CAP",
               "fieldValue": "30000"
            }
         ]
      }
   ]
}

Dettaglio contatto

Anagrafica di un contatto

Richiesta

Risposta

HTTP Status Code

Proprietà contatto:

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  https://api.amm.cloud/sms/v2/phonebook/contact/123456789

   {
         "id": 123456789,
         "msisdn":"393480000000",
         "name":"Mario",
         "lastname":"Rossi",,
         "email":"mario.rossi@fake.it",
         "groups":[
            {
               "id":13197,
               "name":"Amici"
            },
            {
               "id":1947,
               "name":"Lavoro"
            }
         ],
         "customFields":[
            {
               "fieldKey": "f_indirizzo",
               "fieldName": "Indirizzo",
               "fieldValue": "via roma 1"
            },
            {
               "fieldKey": "f_cap",
               "fieldName": "CAP",
               "fieldValue": "30000"
            }
         ]
      }

Nuovo contatto

Aggiungere contatto in rubrica

Richiesta

Risposta

HTTP Status Code

In caso il contatto venga creato correttamente (HTTP status 200) viene restituito il dettaglio del contatto

Per il dettaglio delle proprietà del contatto vedi la funzione Dettaglio contatto.

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  -XPOST https://api.amm.cloud/sms/v2/phonebook/contact \
-d "msisdn=393480000000" \
-d "name=Mario" \
-d "lastname=Rossi" \
-d "f_indirizzo=via roma 1"

{
   "id": 123456789,
   "msisdn":"393480000000",
   "name":"Mario",
   "lastname":"Rossi"
   "customFields":[
      {
          "fieldKey": "f_indirizzo",
          "fieldName": "Indirizzo",
          "fieldValue": "via roma 1"
      }
   ]
}

Aggiungi contatti

Carica massivamente contatti.

Richiesta

Risposta

HTTP Status Code

Risposta

 Esempio:

• CURL
• JAVA
• PHP
• PYTHON
• C#

curl --user AUTH_KEY:AUTH_SECRET \
-XPOST "https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk" \
-F "file=@prova_rubrica.csv"

HttpResponse contactAddBulk_response = Unirest.post("https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk")
        .header("accept", "application/json")
        .basicAuth(SMS_AUTH_KEY, SMS_SECRET_KEY)
        .field("file", new File("prova_rubrica.csv"))
        .asJson();

Unirest\Request::auth(SMS_AUTH_KEY, SMS_SECRET_KEY);

$headers = array(
  'Accept' => 'application/json'
);

$param = array(
);
$files = array('file' => 'prova_rubrica.csv');

$body = Unirest\Request\Body::multipart($param, $files);

$response = Unirest\Request::post('https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk', $headers,$body);

  
response = unirest.post(
    "https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk",
    headers={
        "Accept": "application/json"
        },
    auth=(setup.AUTH_KEYS,setup.AUTH_SECRET),
    params={
        "file": open("prova_rubrica.csv", mode="r")
        }
    )

  
byte[] data = contact_addbulk_file.FileBytes;

HttpResponse jsonResponse = Unirest.post("https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk")
    .header("accept", "application/json")
    .basicAuth(tbAuth_key.Text, tbAuth_secret.Text)
    .field("file", data)
    .asString();

  {
    "status": "SUBMITTED"
  }  

Aggiungi contatti stato

Controlla lo stato della coda inserimento massivo contatti.

Richiesta

Risposta

HTTP Status Code

Risposta

 Esempio:

• CURL
• JAVA
• PHP
• PYTHON
• C#

curl --user AUTH_KEY:AUTH_SECRET \
-XGET "https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk_status"

HttpResponse contactAddBulkStatus_response = Unirest.get("https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk_status")
      .header("accept", "application/json")
      .basicAuth(SMS_AUTH_KEY, SMS_SECRET_KEY)
      .asJson();

Unirest\Request::auth(SMS_AUTH_KEY, SMS_SECRET_KEY);

$headers = array(
  'Accept' => 'application/json'
);

$response = Unirest\Request::get('https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk_status', $headers);

  
response = unirest.get(
    "https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk_status",
    headers={
        "Accept": "application/json"
        },
    auth=(SMS_AUTH_KEY, SMS_SECRET_KEY),
    params={
        }
    )

  
HttpResponse jsonResponse = Unirest.get("https://api.amm.cloud/sms/v2/phonebook/contact/addContactBulk_status")
    .header("accept", "application/json")
    .basicAuth(tbAuth_key.Text, tbAuth_secret.Text)
    .asString();

{
  "progress": "100%",
  "free": true
}

Aggiorna contatto

Modificare un contatto in rubrica

Richiesta

Risposta

HTTP Status Code

In caso il gruppo venga creato correttamente viene restituito lo stato HTTP status 200

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  -XPUT https://api.amm.cloud/sms/v2/phonebook/contact/393480000000 \
-d "name=Mario" \
-d "lastname=Bianchi"

HTTP status 200

Elimina contatto

Eliminare un contatto in rubrica

Richiesta

Risposta

HTTP Status Code

Se il contatto è eliminato correttamente viene restituito lo stato HTTP 204

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET  -XDELETE https://api.amm.cloud/sms/v2/phonebook/contact/123456789

HTTP status 204

Aggiungere un contatto a un gruppo

Aggiunge un contatto ad un gruppo (lista) nella rubrica

Richiesta

Risposta

HTTP Status Code

 Esempio:

    curl --user AUTH_KEY:AUTH_SECRET \ 
       -XPUT https://api.amm.cloud/sms/v2/phonebook/contact/123456789/groups/add \
       -d "groupsId=1234567"

HTTP status 204

Rimuovere un contatto da un gruppo

Rimuove un contatto da un gruppo (lista) nella rubrica

Richiesta

Risposta

HTTP Status Code

 Esempio:

    curl --user AUTH_KEY:AUTH_SECRET \ 
       -XPUT https://api.amm.cloud/sms/v2/phonebook/contact/123456789/groups/remove \
       -d "groupsId=1234567"

HTTP status 204