Obtenir la liste des groupes de contacts

URL

GET https://api.smspartner.fr/v1/group/list

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

apiKey	Clé API de votre compte. Vous l’obtenez dans votre compte SMS Partner.

Requête

Exemple de requête :

<span style="font-weight: 400;">curl --location --request GET
</span><span style="font-weight: 400;">'https://api.smspartner.fr/v</span><span style="font-weight: 400;">1</span><span style="font-weight: 400;">/group/list?apiKey=YOUR_API_KEY'</span>

1 2	<span style="font-weight: 400;">curl --location --request GET </span><span style="font-weight: 400;">'https://api.smspartner.fr/v</span><span style="font-weight: 400;">1</span><span style="font-weight: 400;">/group/list?apiKey=YOUR_API_KEY'</span>

Réponses

<span style="font-weight: 400;">{</span>
<span style="font-weight: 400;">"success": </span><span style="font-weight: 400;">false</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"groups": [</span>
<span style="font-weight: 400;">{</span>
<span style="font-weight: 400;">"id": </span><span style="font-weight: 400;">"identifiant du groupe"</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"name": </span><span style="font-weight: 400;">"groupe name"</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"createdAt": </span><span style="font-weight: 400;">"2020-10-02T16:40:05+02:00"</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"isSpecialFile": </span><span style="font-weight: 400;">false</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"isLocationFile": </span><span style="font-weight: 400;">false</span>
<span style="font-weight: 400;">},...</span>

{

"success": false,

"groups": [

{

"id": "identifiant du groupe",

"name": "groupe name",

"createdAt": "2020-10-02T16:40:05+02:00",

"isSpecialFile": false,

"isLocationFile": false

},...

Erreurs

Exemple de message d’erreur:

<span style="font-weight: 400;">{</span>
<span style="font-weight: 400;">"success": </span><span style="font-weight: 400;">false</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"code": </span><span style="font-weight: 400;">10</span><span style="font-weight: 400;">,</span>
<span style="font-weight: 400;">"message": </span><span style="font-weight: 400;">"Clef API incorrecte"</span>
<span style="font-weight: 400;">}</span>

{

"success": false,

"code": 10,

"message": "Clef API incorrecte"

}

Code de contrôle

	Codes erreur
10	La Clé API est requise