logoドキュメント
SMS
ドキュメントホーム
製品概要クイックアクセスコンソールREST APISMSHook
検索
日本語
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
ログイン
REST API / SMSラベル

タグ

最新更新：2025-07-22

以下のAPIは、SMSタグのクエリ、追加、変更、削除を可能にします。

単一タグのクエリ

SMSタグに関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}
              
              https://sms.api.engagelab.cc/v1/labels/{label_id}
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET
              
              GET
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(sms_user:sms_key)

リクエスト例

curl -X GET "https://sms.api.engagelab.cc/v1/labels/598802" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels/598802" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス説明

フィールド 説明
label_id タグID
label_name タグ名
create_time 作成日時
update_time 更新日時

レスポンス例

レスポンス-成功

HTTPステータス: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }
              
              {
        "result": 
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
            }
}
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス-エラー

HTTPステータス: 400

{ "code": 34020, "message": "label_id must be a integer" }
              
              {
  "code": 34020,
  "message": "label_id must be a integer"
}
このコードブロックはフローティングウィンドウ内に表示されます

複数タグのクエリ

SMSタグに関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/labels
              
              https://sms.api.engagelab.cc/v1/labels
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET
              
              GET
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(sms_user:sms_key)

クエリパラメータ説明

パラメータ タイプ 必須 説明
offset Integer No クエリ開始位置、範囲[0-]、デフォルトは0
limit Integer No クエリ数、範囲[0-100]、デフォルトは100
label_name string No タグ名、あいまい検索をサポート

リクエスト例

curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" --header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"
              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" 
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス説明

フィールド 説明
label_id タグID
label_name タグ名
create_time 作成日時
update_time 更新日時

レスポンス例

レスポンス-成功

HTTPステータス: 200

{ "result": [ { "create_time": "2022-11-14T14:27:48+0800", "label_id": 10, "label_name": "test", "update_time": "2022-11-14T14:27:48+0800" } ] "total": 28, "count": 1 }
              
              {
        
        "result": [
           {
                "create_time": "2022-11-14T14:27:48+0800",
                "label_id": 10,
                "label_name": "test",
                "update_time": "2022-11-14T14:27:48+0800"
            }
        ]
        "total": 28,
        "count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス-エラー

HTTPステータス: 401

{ "code": 30000, "message": "Unauthorized." }
              
              {  
    "code": 30000,
    "message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます

タグの追加

追加成功後、SMSタグに関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/labels
              
              https://sms.api.engagelab.cc/v1/labels
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

POST
              
              POST
このコードブロックはフローティングウィンドウ内に表示されます

Content-type

application/json
              
              application/json
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization string true Basic base64(sms_user:sms_key)

パラメータ説明

パラメータ タイプ 必須 説明
label_name string Yes タグ名、最大64文字

注意:

  1. タグ作成の最大制限は100,000です。

リクエスト例

curl -X POST "https://sms.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test2" }' 
              
              curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test2"
}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス説明

フィールド 説明
label_id タグID
label_name タグ名
create_time 作成日時
update_time 更新日時

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "label_id": 11, "label_name": "test", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }
              
              {
        "result": {
            "label_id": 11,
            "label_name": "test",
            "create_time": "2022-11-14T14:27:48+0800",
            "update_time": "2022-11-14T14:27:48+0800"
        }
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    "code": 30000,
    "message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます

タグの更新

更新成功後、SMSタグに関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}
              
              https://sms.api.engagelab.cc/v1/labels/{label_id}
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

PUT
              
              PUT
このコードブロックはフローティングウィンドウ内に表示されます

Content-type

application/json
              
              application/json
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(sms_user:sms_key)

パラメータ説明

パラメータ タイプ 必須 説明
label_name string Yes タグ名、最大64文字

リクエスト例

curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test3" }' 
              
              curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test3"
}'
このコードブロックはフローティングウィンドウ内に表示されます

レスポンス説明

パラメータ 説明
count 成功した変更の数

レスポンス例

Response-success

HTTP Status: 200

{ "count":1 }
              
              {
    "count":1
}
このコードブロックはフローティングウィンドウ内に表示されます

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
              
              {
    "code": 30000,
    "message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます

タグの削除

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}
              
              https://sms.api.engagelab.cc/v1/labels/{label_id}
このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

DELETE
              
              DELETE
このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

ヘッダー タイプ 必須 説明
Authorization String true Basic base64(sms_user:sms_key)

リクエスト例

curl -X DELETE "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/labels/11" 
--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."
}
このコードブロックはフローティングウィンドウ内に表示されます
icon
お問い合わせ