SMS署名

以下のインターフェースを通じて、SMS署名のクエリ、追加、変更を行うことができます。

単一署名のクエリ

SMS署名に関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

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

HTTPリクエストメソッド

GET

GET

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

リクエストヘッダー

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

リクエスト例

curl -X GET "https://sms.api.engagelab.cc/v1/signs/10" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/signs/10" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

レスポンス説明

フィールド	説明
sign_id	署名ID
sign_name	署名名
create_time	作成時間
update_time	更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "sign_id": 10, "sign_name": "shanshan", "create_time": "2021-04-10T10:44:37+0800", "update_time": "2022-06-14T19:20:35+0800" } }

              
              {
    "result": {
            "sign_id": 10,
            "sign_name": "shanshan",
            "create_time": "2021-04-10T10:44:37+0800",
            "update_time": "2022-06-14T19:20:35+0800"
        
    }
}

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

Response-error

HTTP Status :400

{ "code": 34010, "message": "sign not exists" }

              
              {
    "code": 34010,
    "message": "sign not exists"
}

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

複数署名のクエリ

SMSテンプレートに関する基本情報を返します。

URL

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

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

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

HTTPリクエストメソッド

GET

GET

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

リクエストヘッダー

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

パラメータ説明

パラメータ	タイプ	必須	説明
sign_name	string	No	署名名、あいまい検索をサポート

リクエスト例

curl -X GET "https://sms.api.engagelab.cc/v1/signs" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/signs" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

レスポンス説明

フィールド	説明
sign_id	署名ID
sign_name	署名名
create_time	作成時間
update_time	更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": [{ "sign_id": 1427, "sign_name": "shanshan", "create_time": "2015-04-10T10:44:37+0800", "update_time": "2016-06-14T19:20:35+0800" } ], "count":1, "total":1 }

              
              {
    "result":  [{
                "sign_id": 1427,
                "sign_name": "shanshan",
                "create_time": "2015-04-10T10:44:37+0800",
                "update_time": "2016-06-14T19:20:35+0800"
            }
        ],
    "count":1,
    "total":1
    
}

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

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
  "code": 30000,
  "message": "Authentication failed"
}

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

署名の追加

追加されたSMS署名に関する基本情報を返します。

URL

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

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

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

HTTPリクエストメソッド

POST

              
              POST

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

Content-type

application/json

              
              application/json

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

リクエストヘッダー

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

パラメータ説明

パラメータ	タイプ	必須	説明
sign_name	string	Yes	署名名、長さは2〜60文字、記号[]または【】を含めることはできません

注意:

作成可能な署名の最大数は100です。

リクエスト例

curl -X POST "https://sms.api.engagelab.cc/v1/signs" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "sign_name": "ccc" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/signs"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "sign_name": "ccc"
}'

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

レスポンス説明

フィールド	説明
sign_id	署名ID
sign_name	署名名
create_time	作成時間
update_time	更新時間

レスポンス例

Response-success

HTTP Status: 200

{ "result": { "sign_id": 1529, "sign_name": "ccc", "create_time": "2015-04-10T10:44:37+0800", "update_time": "2016-06-14T19:20:35+0800" } }

              
              {
    "result": {
                "sign_id": 1529,
                "sign_name": "ccc",
                "create_time": "2015-04-10T10:44:37+0800",
                "update_time": "2016-06-14T19:20:35+0800"
    }
}

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

Response-error

HTTP Status: 400

{ "code": 34005, "message": "Invalid sign_name" }

              
              {
    "code": 34005,
    "message": "Invalid sign_name"
}

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

署名の更新

更新されたSMS署名に関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

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

HTTPリクエストメソッド

PUT

PUT

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

Content-type

application/json

              
              application/json

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

リクエストヘッダー

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

パラメータ説明

パラメータ	タイプ	必須	説明
sign_name	string	true	署名名、長さは2〜60文字、記号[]または【】を含めることはできません

リクエスト例

curl -X PUT "https://api.sendcloud.net/v1/signs/11617" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "sign_name": "ccc" }'

              
              curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "sign_name": "ccc"
}'

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

レスポンス例

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-error

HTTP Status: 400

{ "code": 34005, "message": "Invalid sign_name" }

              
              {
    "code": 34005,
    "message": "Invalid sign_name"
}

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

署名の削除

削除が成功したかどうかに関する基本情報を返します。

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

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

HTTPリクエストメソッド

DELETE

              
              DELETE

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

リクエストヘッダー

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

リクエスト例

curl -X DELETE "https://api.sendcloud.net/v1/signs/11617" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://api.sendcloud.net/v1/signs/11617" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

レスポンス例

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

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