Kontak

Anda dapat mencari, menambah, menghapus, dan memperbarui daftar kontak SMS melalui antarmuka berikut.

Query Daftar Kontak

Mengembalikan informasi dasar daftar kontak SMS.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
offset	Integer	tidak	posisi offset, [0-], default 0
limit	Integer	tidak	jumlah, [0-100], default 100
contact_list_name	string	tidak	nama daftar kontak, mendukung pencarian kabur

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
contact_list_id	ID daftar kontak
contact_list_name	nama daftar kontak
description	deskripsi daftar kontak
member_count	jumlah kontak dalam daftar
create_time	waktu pembuatan daftar kontak
update_time	waktu modifikasi daftar kontak

Contoh Nilai Balikan

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

Tampilkan blok kode ini di jendela mengambang

Tambah Daftar Kontak

Mengembalikan informasi daftar kontak yang berhasil ditambahkan.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
contact_list_name	string	ya	nama daftar kontak, hanya boleh angka, huruf, garis bawah, atau strip, maksimal 48 karakter
description	string	tidak	informasi deskriptif, maksimal 255 karakter

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
contact_list_id	ID daftar kontak
contact_list_name	nama daftar kontak
description	deskripsi daftar kontak
member_count	jumlah kontak dalam daftar
create_time	waktu pembuatan daftar kontak
update_time	waktu modifikasi daftar kontak

Contoh Nilai Balikan

Respon-berhasil

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

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35004, "message": "contact_list_name tidak boleh kosong" }

              
              // contoh hasil balikan gagal
{
    "code": 35004,
    "message": "contact_list_name tidak boleh kosong"
}

Tampilkan blok kode ini di jendela mengambang

Ubah Daftar Kontak

Mengembalikan informasi dasar dari daftar kontak yang berhasil diperbarui.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
contact_list_name	string	tidak	nama daftar kontak, hanya boleh angka, huruf, garis bawah, atau strip, maksimal 48 karakter
description	string	tidak	informasi deskriptif, maksimal 255 karakter

Tips：

Waktu daftar hanya diperbarui jika 'contact_list_name' dan 'description' diubah. Waktu pembaruan tidak berubah saat hanya anggota yang diperbarui.

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
count	jumlah modifikasi yang berhasil

Contoh Nilai Balikan

Respon-berhasil

HTTP Status: 200

{ "count":1 }

              
              {
    "count":1
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35004, "message": "contact_list_name tidak boleh kosong" }

              
              // contoh hasil balikan gagal
{
    "code": 35004,
    "message": "contact_list_name tidak boleh kosong"
}

Tampilkan blok kode ini di jendela mengambang

Hapus Daftar Kontak

Mengembalikan informasi apakah penghapusan berhasil.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Content-type

application/x-www-form-urlencoded

              
              application/x-www-form-urlencoded

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
count	jumlah daftar yang dihapus

Contoh Nilai Balikan

Respon-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
"count": 1 
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35008, "message": "contactListName tidak ditemukan" }

              
              // contoh hasil balikan gagal
{
    "code": 35008,
    "message": "contactListName tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang

Anda juga dapat mencari, menambah, menghapus, dan memperbarui anggota daftar kontak SMS melalui antarmuka berikut.

Query Anggota Daftar

Mengembalikan informasi dasar anggota dalam daftar kontak 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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
offset	Integer	tidak	posisi offset, [0-], default 0
limit	Integer	tidak	jumlah, [0-100], default 100
phone	string	tidak	nomor telepon anggota, mendukung pencarian kabur
member_ids	string	tidak	ID anggota, gunakan titik koma untuk beberapa, maksimal 100

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
member_id	ID anggota
phone	nomor telepon anggota
name	nama anggota
vars	variabel
create_time	waktu pembuatan daftar kontak
update_time	waktu modifikasi daftar kontak

Contoh Nilai Balikan

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

Tampilkan blok kode ini di jendela mengambang

Tambah Anggota Daftar

Menambahkan anggota ke daftar kontak.

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

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
members	Array [object]	ya	daftar anggota, maksimal 1000 anggota
phone	string	ya	nomor telepon, format internasional
name	string	tidak	nama anggota, maksimal 48 karakter
vars	object	tidak	variabel, maksimal 1 KB

Tips:

Saat menambahkan variabel vars, key tidak perlu menggunakan '%', dan panjang key maksimal 32 karakter.

Dalam variabel vars, variabel dengan key name akan ditimpa oleh parameter name.

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
count	jumlah anggota yang ditambah
invalid	anggota tidak valid

Contoh Nilai Balikan

Respon-berhasil

HTTP Status: 200

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

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

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35008, "message": "contactListId tidak ditemukan" }

              
              // contoh hasil balikan gagal
{
    "code": 35008,
    "message": "contactListId tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang

Ubah Anggota Daftar

Memperbarui anggota daftar kontak.

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}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
member	Object	ya	anggota daftar kontak
phone	string	tidak	nomor telepon, format internasional
name	string	tidak	nama anggota, maksimal 48 karakter
vars	object	tidak	variabel, maksimal 1 KB. Panjang key maksimal 32 karakter

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
count	jumlah kontak yang diperbarui

Contoh Nilai Balikan

Respon-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35008, "message": "contactListId tidak ditemukan" }

              
              // contoh hasil balikan gagal
{
    "code": 35008,
    "message": "contactListId tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang

Hapus Anggota Daftar

Mengembalikan status keberhasilan penghapusan.

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}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Content-type

application/x-www-form-urlencoded

              
              application/x-www-form-urlencoded

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Contoh Permintaan

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter	Deskripsi
count	jumlah kontak yang dihapus

Contoh Nilai Balikan

Respon-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
"count": 1 
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

// contoh hasil balikan gagal { "code": 35008, "message": "contactListId tidak ditemukan" }

              
              // contoh hasil balikan gagal
{
    "code": 35008,
    "message": "contactListId tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang