Kontakt

Sie können die SMS-Kontaktliste über die folgenden Schnittstellen abfragen, hinzufügen, löschen und aktualisieren.

Kontaktliste abfragen

Gibt Basisinformationen der SMS-Kontaktliste zurück

URL

https://sms.api.engagelab.cc/v1/contact_lists

              
              https://sms.api.engagelab.cc/v1/contact_lists

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
offset	Integer	nein	Offset-Position, [0-], Standardwert 0
limit	Integer	nein	Anzahl, [0-100], Standardwert 100
contact_list_name	string	nein	Name der Kontaktliste, unterstützt unscharfe Suche

Anfragebeispiel

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>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
contact_list_id	ID der Kontaktliste
contact_list_name	Name der Kontaktliste
description	Beschreibung der Kontaktliste
member_count	Anzahl Kontakte in der Liste
create_time	Erstellungszeit der Kontaktliste
update_time	Änderungszeit der Kontaktliste

Rückgabewert-Beispiel

{ "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
    
}

Diesen Codeblock im schwebenden Fenster anzeigen

Kontaktliste hinzufügen

Gibt Kontaktlisteninformationen für erfolgreich hinzugefügte Kontakte zurück.

URL

https://sms.api.engagelab.cc/v1/contact_lists

              
              https://sms.api.engagelab.cc/v1/contact_lists

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
contact_list_name	string	ja	Kontaktlistenname. Nur Zahlen, Buchstaben, Unterstrich, Bindestrich, max. 48 Zeichen
description	string	nein	Beschreibung, maximal 255 Zeichen

Anfragebeispiel

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"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
contact_list_id	ID der Kontaktliste
contact_list_name	Name der Kontaktliste
description	Beschreibung der Kontaktliste
member_count	Anzahl Kontakte in der Liste
create_time	Erstellungszeit der Kontaktliste
update_time	Änderungszeit der Kontaktliste

Rückgabewert-Beispiel

Antwort-Erfolg

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"	
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35004, "message": "contact_list_name darf nicht leer sein" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35004,
        "message": "contact_list_name darf nicht leer sein"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Kontaktliste bearbeiten

Gibt die Basisinformationen der erfolgreich aktualisierten Kontaktliste zurück

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}

              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
contact_list_name	string	nein	Kontaktlistenname. Nur Zahlen, Buchstaben, Unterstrich, Bindestrich, max. 48 Zeichen
description	string	nein	Beschreibung, maximal 255 Zeichen

Hinweise：

Die Listenzeit wird nur aktualisiert, wenn 'contact_list_name' und 'description' geändert werden. Werden nur Mitglieder aktualisiert, ändert sich die Listenzeit nicht.

Anfragebeispiel

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"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
count	Anzahl der erfolgreichen Änderungen

Rückgabewert-Beispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count":1 }

              
              {
    "count":1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35004, "message": "contact_list_name darf nicht leer sein" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35004,
        "message": "contact_list_name darf nicht leer sein"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Kontaktliste löschen

Gibt Basisinformationen darüber zurück, ob die Löschung erfolgreich war

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}

              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/x-www-form-urlencoded

              
              application/x-www-form-urlencoded

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Anfragebeispiel

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>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
count	Anzahl gelöschter Listen

Rückgabewert-Beispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }

              
              {
"count": 1 
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35008, "message": "Der contactListName existiert nicht" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35008,
        "message": "Der contactListName existiert nicht"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Sie können Mitglieder der SMS-Kontaktliste über die folgenden Schnittstellen abfragen, hinzufügen, löschen und aktualisieren.

Listenmitglied abfragen

Gibt Basisinformationen über die Mitglieder der SMS-Kontaktliste zurück

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
offset	Integer	nein	Offset-Position, [0-], Standardwert 0
limit	Integer	nein	Anzahl, [0-100], Standardwert 100
phone	string	nein	Telefonnummer, unterstützt unscharfe Suche
member_ids	string	nein	Mitglieder-ID(s), mehrere mit Komma getrennt, maximal 100

Anfragebeispiel

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>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
member_id	ID des Mitglieds
phone	Telefonnummer des Mitglieds
name	Name des Mitglieds
vars	Variablen
create_time	Erstellzeit des Kontakts in der Liste
update_time	Änderungszeit des Kontakts in der Liste

Rückgabewert-Beispiel

{ "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
}

Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied hinzufügen

Fügt Mitglieder zur Kontaktliste hinzu

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

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

POST

              
              POST

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
members	Array [object]	ja	Liste der Mitglieder, bis zu 1000 Einträge möglich
phone	string	ja	Telefonnummer im internationalen Format
name	string	nein	Name des Mitglieds, maximal 48 Zeichen
vars	object	nein	Variablen, maximal 1 KB

Hinweise:

Beim Hinzufügen von Variablen (vars) muss der Schlüssel kein '%' enthalten. Die maximale Schlüssellänge: 32 Zeichen.

Im vars-Objekt wird der Schlüssel "name" durch den Parameter "name" überschrieben.

Anfragebeispiel

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"}
        }
    ]
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
count	Anzahl der hinzugefügten Mitglieder
invalid	Ungültige Mitglieder

Rückgabewert-Beispiel

Antwort-Erfolg

HTTP-Status: 200

{ "result": { "count": 1, "invalid": ["130****"] } }

              
              {
   "result": {
        "count": 1,
        "invalid": ["130****"]
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35008, "message": "Die contactListId existiert nicht" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35008,
        "message": "Die contactListId existiert nicht"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied bearbeiten

Aktualisiert Mitglieder der Kontaktliste

URL

https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_id}

              
              https://sms.api.engagelab.cc/v1/contact_lists/{contact_member_id}/members/{member_id}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

PUT

PUT

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/json

              
              application/json

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Parameterbeschreibung

Parameter	Typ	Erforderlich	Beschreibung
member	Object	ja	Mitglied der Kontaktliste
phone	string	nein	Telefonnummer im internationalen Format
name	string	nein	Name des Mitglieds, maximal 48 Zeichen
vars	object	nein	Variablen, maximal 1 KB. Die Schlüssellänge max. 32 Zeichen

Anfragebeispiel

curl -X POST "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 POST "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"}
        }
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
count	Anzahl der bearbeiteten Kontakte

Rückgabewert-Beispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35008, "message": "Die contactListId existiert nicht" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35008,
        "message": "Die contactListId existiert nicht"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Listenmitglied löschen

Gibt zurück, ob das Löschen erfolgreich war

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}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Anfragemethode

DELETE

              
              DELETE

Diesen Codeblock im schwebenden Fenster anzeigen

Content-Type

application/x-www-form-urlencoded

              
              application/x-www-form-urlencoded

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Header	Typ	Erforderlich	Beschreibung
Authorization	String	ja	Basic base64(sms_user:sms_key)

Anfragebeispiel

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>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabewert-Beschreibung

Parameter	Beschreibung
count	Anzahl der gelöschten Kontakte

Rückgabewert-Beispiel

Antwort-Erfolg

HTTP-Status: 200

{ "count": 1 }

              
              {
"count": 1 
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :401

{ "code": 30000, "message": "Nicht autorisiert." }

              
              {
    "code": 30000,
    "message": "Nicht autorisiert."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwort-Fehler

HTTP-Status :400

// Beispiel für fehlerhafte Rückgabe { "code": 35008, "message": "Die contactListId existiert nicht" }

              
              // Beispiel für fehlerhafte Rückgabe
{
    "code": 35008,
        "message": "Die contactListId existiert nicht"
}

Diesen Codeblock im schwebenden Fenster anzeigen