Contact
Vous pouvez interroger, ajouter, supprimer et mettre à jour la liste de contacts SMS via l'interface suivante.
Interroger la liste de contacts
Retourne les informations de base de la liste de contacts SMS
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | Integer | non | position de décalage, [0-], par défaut à 0 |
| limit | Integer | non | quantité, [0-100], par défaut à 100 |
| contact_list_name | string | non | nom de la liste de contacts, prend en charge les recherches floues |
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists?contact_list_name=test"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| contact_list_id | ID de la liste de contacts |
| contact_list_name | nom de la liste de contacts |
| description | description de la liste de contacts |
| member_count | nombre de contacts dans la liste |
| create_time | date de création de la liste |
| update_time | date de modification de la liste |
Exemple de valeur retournée
{
"result": [{
"contact_list_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_list_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2,
"total": 10
}
{
"result": [{
"contact_list_id": 998,
"contact_list_name": "test",
"description": "",
"member_count": 4,
"create_time": "2016-05-10T15:18:38+0800",
"update_time": "2016-05-11T10:04:20+0800"
},
{
"contact_list_id": 999,
"contact_list_name": "test2",
"description": "",
"member_count": 1,
"create_time": "2016-06-29T12:54:59+0800",
"update_time": "2016-06-29T12:54:59+0800"
}
],
"count":2,
"total": 10
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter une liste de contacts
Retourne les informations de la liste de contacts pour les contacts ajoutés avec succès
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| contact_list_name | string | oui | nom de la liste de contacts, prend uniquement en charge les chiffres, lettres, underscores ou tirets, longueur maximale de 48 caractères |
| description | string | non | informations descriptives, jusqu'à 255 caractères |
Exemple de requête
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "beijing",
"description": "test"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| contact_list_id | ID de la liste de contacts |
| contact_list_name | nom de la liste de contacts |
| description | description de la liste de contacts |
| member_count | nombre de contacts dans la liste |
| create_time | date de création de la liste |
| update_time | date de modification de la liste |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
{
"result": {
"contact_list_id": 35,
"contact_list_name": "beijing",
"description": "test",
"member_count": 28,
"create_time": "2016-08-02T14:06:10+0800",
"update_time": "2017-05-19T10:55:24+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// exemple de résultats d'échec
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier la liste de contacts
Retourne les informations de base de la liste de contacts mise à jour avec succès
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
PUT
PUT
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| contact_list_name | string | non | nom de la liste de contacts, prend uniquement en charge les chiffres, lettres, underscores ou tirets, longueur maximale de 48 caractères |
| description | string | non | informations descriptives, jusqu'à 255 caractères |
Astuces :
- L'heure de la liste n'est mise à jour que lors de la modification de 'contact_list_name' et 'description', et l'heure de mise à jour de la liste n'est pas modifiée lors de la mise à jour des membres.
Exemple de requête
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"contact_list_name": "shanghai",
"description": "222"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre de modifications réussies |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count":1
}
{
"count":1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// exemple de résultats d'échec
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer la liste de contacts
Retourne les informations de base sur la réussite de la soumission
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Exemple de requête
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre de listes supprimées |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListName does not exist"
}
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListName does not exist"
}
Afficher ce bloc de code dans la fenêtre flottante
Vous pouvez interroger, ajouter, supprimer et mettre à jour les membres de la liste de contacts SMS via l'interface suivante.
Interroger les membres de la liste
Retourne les informations de base des membres de la liste de contacts SMS
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | Integer | non | position de décalage, [0-], par défaut à 0 |
| limit | Integer | non | quantité, [0-100], par défaut à 100 |
| phone | string | non | numéro de téléphone du membre, prend en charge les recherches floues |
| member_ids | string | non | ID du membre, plusieurs séparés par ;, jusqu'à 100 |
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/contact_lists/1025/members?phone=15652496875"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| member_id | ID du membre |
| phone | numéro de téléphone du membre |
| name | nom du membre |
| vars | variables |
| create_time | date de création de la liste |
| update_time | date de modification de la liste |
Exemple de valeur retournée
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"member_id": 440164,
"phone": "18********",
"name": "",
"vars": "{'beizhu':'hello'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
},
{
"member_id": 440964,
"phone": "13********",
"name": "",
"vars": "{'beizhu':'ss'}",
"create_time": "2016-10-18T15:13:27+0800",
"update_time": "2016-10-18T15:13:27+0800",
}
],
"total": 2,
"count": 2
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter un membre à la liste
Ajouter des membres à la liste de contacts
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| members | Array [object] | oui | liste des membres, jusqu'à 1000 membres |
| phone | string | oui | téléphone, format international |
| name | string | non | nom du membre, maximum 48 caractères |
| vars | object | non | variables, maximum 1 Ko |
Astuces :
- Lors de l'ajout de variables vars, notez que la clé n'a pas besoin d'être marquée avec '%', et la longueur de la clé ne peut pas dépasser 32 caractères.
- Dans la variable vars, la variable dont la clé est name sera écrasée par le paramètre name.
Exemple de requête
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
curl -X POST "https://sms.api.engagelab.cc/v1/contact_lists/1024/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"members": [
{
"phone": "+86158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
},
{
"phone": "+8618754265414",
"name": "aaa",
"vars": {"sex":"female","code":"2"}
}
]
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre de membres ajoutés |
| invalid | membre invalide |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier un membre de la liste
Mettre à jour les membres de la liste de contacts
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
PUT
PUT
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| member | Object | oui | membre de la liste de contacts |
| phone | string | non | téléphone, format international |
| name | string | non | nom du membre, maximum 48 caractères |
| vars | object | non | variables, maximum 1 Ko. La longueur de la clé ne peut pas dépasser 32 caractères |
Exemple de requête
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
curl -X PUT "https://sms.api.engagelab.cc/v1/contact_lists/1024/members/251224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"member":
{
"phone": "158452369825",
"name": "aaa",
"vars": {"sex":"male","code":"1"}
}
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre de contacts modifiés |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer un membre de la liste
Retourne si la suppression a réussi
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}/members/{member_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(sms_user:sms_key) |
Exemple de requête
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/contact_lists/11/members/1234"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre de contacts supprimés |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
// exemple de résultats d'échec
{
"code": 35008,
"message": "The contactListId does not exist"
}
Afficher ce bloc de code dans la fenêtre flottante
