連絡先リスト
以下のAPIを使用して、SMS連絡先リストを照会、追加、削除、および更新することができます。
連絡先リストの照会
SMS連絡先リストに関する基本情報を返します。
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーターの説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| offset | Integer | No | 照会開始位置、範囲[0-]、デフォルトは0 |
| limit | Integer | No | 照会件数、範囲[0-100]、デフォルトは100 |
| contact_list_name | string | No | 連絡先リスト名、あいまい検索をサポート |
リクエスト例
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>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| フィールド | 説明 |
|---|---|
| contact_list_id | 連絡先リストID |
| contact_list_name | 連絡先リスト名 |
| description | 説明 |
| member_count | メンバー数 |
| create_time | 作成時間 |
| update_time | 更新時間 |
レスポンス例
{
"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
}
このコードブロックはフローティングウィンドウ内に表示されます
連絡先リストの追加
正常に追加された連絡先リストに関する情報を返します。
URL
https://sms.api.engagelab.cc/v1/contact_lists
https://sms.api.engagelab.cc/v1/contact_lists
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/json
application/json
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーターの説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| contact_list_name | string | Yes | 連絡先リスト名、数字、文字、アンダースコア、またはハイフンのみをサポート、最大48文字 |
| description | string | No | 説明、最大255文字 |
リクエスト例
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"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| フィールド | 説明 |
|---|---|
| contact_list_id | 連絡先リストID |
| contact_list_name | 連絡先リスト名 |
| description | リストの説明 |
| member_count | メンバー数 |
| create_time | 作成時間 |
| update_time | 更新時間 |
レスポンス例
Response-success
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"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗したレスポンス例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// 失敗したレスポンス例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
このコードブロックはフローティングウィンドウ内に表示されます
連絡先リストの更新
正常に更新された連絡先リストに関する基本情報を返します。
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/json
application/json
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーターの説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| contact_list_name | string | No | 連絡先リスト名、数字、文字、アンダースコア、またはハイフンのみをサポート、最大48文字 |
| description | string | No | 説明、最大255文字 |
注記:
- リストのcontact_list_nameとdescriptionを更新するとリストの更新時間が更新されますが、メンバーを更新してもリストの更新時間は更新されません。
リクエスト例
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"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| フィールド | 説明 |
|---|---|
| count | 正常に変更されたレコード数 |
レスポンス例
Response-success
HTTP Status: 200
{
"count":1
}
{
"count":1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗したレスポンス例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
// 失敗したレスポンス例
{
"code": 35004,
"message": "contact_list_name cannot be empty"
}
このコードブロックはフローティングウィンドウ内に表示されます
連絡先リストの削除
送信が成功したかどうかに関する基本情報を返します。
URL
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
https://sms.api.engagelab.cc/v1/contact_lists/{contact_list_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
DELETE
DELETE
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
リクエスト例
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>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
| フィールド | 説明 |
|---|---|
| count | 正常に削除されたレコード数 |
レスポンス例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗したレスポンス例
{
"code": 35008,
"message": "The contactListName does not exist"
}
// 失敗したレスポンス例
{
"code": 35008,
"message": "The contactListName does not exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
以下のインターフェースを使用して、SMS連絡先リストのメンバーを照会、追加、削除、更新することができます。
リストメンバーの照会
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
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーター説明
| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | Integer | no | オフセット位置、[0-]、デフォルトは0 |
| limit | Integer | no | 数量、[0-100]、デフォルトは100 |
| phone | string | no | メンバーの電話番号、あいまい検索対応 |
| member_ids | string | no | メンバーID、複数はカンマ区切り、最大100個 |
リクエスト例
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>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| Parameter | Description |
|---|---|
| member_id | メンバーID |
| phone | メンバーの電話番号 |
| name | メンバー名 |
| vars | 変数 |
| create_time | 連絡先リスト作成時間 |
| update_time | 連絡先リスト更新時間 |
レスポンス例
{
"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
}
このコードブロックはフローティングウィンドウ内に表示されます
リストメンバーの追加
連絡先リストメンバーを追加します。
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
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/json
application/json
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーター説明
| Parameter | Type | Required | Description |
|---|---|---|---|
| members | Array [object] | yes | メンバーリスト、最大1000人 |
| phone | string | yes | 電話番号、国際電話番号形式 |
| name | string | no | メンバー名、最大48文字 |
| vars | object | no | 変数、最大1KB |
ヒント：
- vars変数を追加する際、keyに'%'を付ける必要はありません。また、keyの長さは32文字を超えないようにしてください。
- vars変数内で、keyがnameの場合、パラメーターnameによって上書きされます。
リクエスト例
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"}
}
]
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| Parameter | Description |
|---|---|
| count | 追加に成功したメンバー数 |
| invalid | 無効なメンバー |
レスポンス例
Response-success
HTTP Status: 200
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
{
"result": {
"count": 1,
"invalid": ["130****"]
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
リストメンバーの修正
連絡先リストメンバーを更新します。
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}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/json
application/json
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーター説明
| Parameter | Type | Required | Description |
|---|---|---|---|
| member | Object | yes | 連絡先リストメンバー |
| phone | string | no | 電話番号、国際電話番号形式 |
| name | string | no | メンバー名、最大48文字 |
| vars | object | no | 変数、最大1KB。keyの長さは32文字を超えないようにしてください |
リクエスト例
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"}
}
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| Parameter | Description |
|---|---|
| count | 修正に成功した連絡先数 |
レスポンス例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
リストメンバーの削除
削除が成功したかどうかを返します。
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}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
DElETE
DElETE
このコードブロックはフローティングウィンドウ内に表示されます
Content-type
application/x-www-form-urlencoded
application/x-www-form-urlencoded
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
リクエスト例
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>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| Parameter | Description |
|---|---|
| count | 削除に成功した連絡先数 |
レスポンス例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
// 失敗時のレスポンス例
{
"code": 35008,
"message": "The contactListId does not exist"
}
このコードブロックはフローティングウィンドウ内に表示されます
