友達トークの API

基本情報

API URL

https://sens.apigw.ntruss.com/friendtalk/v2

SENS友達トークの API Swaggerに移動する

API Header

NAVERクラウドプラットフォームの認証キーおよび Signature作成ガイドに移動する

メッセージ

メッセージ送信

メッセージを送信します。

リクエスト URL

POST https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

{
    "plusFriendId":"string",
    "messages":[
        {
            "isAd":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "buttons":[
                {
                    "type":"string",
                    "name":"string",
                    "linkMobile":"string",
                    "linkPc":"string",
                    "schemeIos":"string",
                    "schemeAndroid":"string"
                }
            ],
            "image":{
                "imageId":"string",
                "imageLink":"string"
            },
            "useSmsFailover": "boolean",
            "failoverConfig": {
                "type": "string",
                "from": "string",
                "subject": "string",
                "content": "string"
            }
        }
    ],
    "reserveTime": "yyyy-MM-dd HH:mm",
    "reserveTimeZone": "string"
}

• リクエスト Bodyの Mandatoryフィールドを使用する場合、空白は許可されません(追加する場合のみ)。
• SMS Failoverは、bizメッセージの受信結果コード基準で成功でない場合に動作し、prefixに Bが付いたコードに対しては、failover機能による SMS代替送信が行われません。
  

• プッシュ型広告の送信時、SMS Failoverに設定された SMSサービスの080受信拒否サービスを使用します。
  • 設定された SMSサービスに080受信拒否サービスが使用可能な状態でない場合、SMS Failoverは失敗します。
  • failoverConfig.contentを別途指定せずに使用する場合、SMS Failover時に自動的に広告表記フレーズを挿入します。

    [広告] {メッセージ内容}
    無料受信拒否番号08012345678
    

  • failoverConfig.contentを別途直接指定する場合、広告表記フレーズを挿入しません。プッシュ型広告を送信する場合、直接追加してください。
  • 広告表記義務を遵守せず SMSメッセージを送信する場合、今後釈明が必要になることがあります。
• ワイド画像の送信時、テキスト+リンクボタン(1つ)+画像送信が可能です。
  • 2つ以上のボタンを追加すると、メッセージの送信に失敗します。(不正なパラメータリクエスト)
  • テキストフレーズは76文字に制限されます。

ボタン情報

レスポンス Body

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messages":[
        {
            "messageId":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "requestStatusCode":"string",
            "requestStatusName":"string",
            "requestStatusDesc":"string",
            "useSmsFailover":"boolean"
        }
    ]
}

レスポンス Status

メッセージ送信リクエストの照会

メッセージの送信リクエストを照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages?requestId=

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Parameters

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

{
    "requestId": "string", 
    "statusCode": "string",
    "statusName": "string",
    "messages": [
        {
            "requestTime": "string",
            "messageId": "string",
            "countryCode": "string",
            "to": "string",
            "content": "string",
            "plusFriendId": "string",
            "completeTime": "string",
            "requestStatusCode": "string",
            "requestStatusName": "string",
            "requestStatusDesc": "string",
            "messageStatusCode": "string",
            "messageStatusName": "string",
            "messageStatusDesc": "string",
            "isWide": "boolean",
            "isAd": "boolean",
            "useSmsFailover": "boolean",
            "failover": {
                "smsServiceId": "string",
                "requestId": "string",
                "messageId": "string",
                "requestStatusCode": "string",
                "requestStatusName": "string",
                "requestStatusDesc": "string",
                "messageStatus": "string",
                "messageStatusCode": "string",
                "messageStatusName": "string",
                "messageStatusDesc": "string"
            }
        }
    ],
    "pageSize": "integer",
    "pageIndex": "integer",
    "itemCount": "integer",
    "hasMore": "boolean"
}

レスポンス Status

メッセージ送信結果の照会

メッセージの送信結果を照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

{
    "messageId":"string",
    "requestId":"string",
    "requestTime":"string",
    "completeTime":"string",
    "plusFriendId":"string",
    "countryCode":"string",
    "to":"string",
    "content":"string",
    "requestStatusCode":"string",
    "requestStatusName":"string",
    "requestStatusDesc":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "messageStatusDesc":"string",
    "isWide":"boolean",
    "isAd":"boolean",
    "imageId":"string",
    "imageName":"string",
    "imageUrl":"string",
    "imageLink":"string",
    "useSmsFailover":"boolean",
    "failover": {
        "smsServiceId":"string",
        "requestId":"string",
        "requestStatusCode":"string",
        "requestStatusName":"string",
        "requestStatusDesc":"string",
        "messageId":"string",
        "messageStatus":"string",
        "messageStatusCode":"string",
        "messageStatusName":"string",
        "messageStatusDesc":"string"
    }
}

Failoverのリクエスト状態コード

レスポンス Status

予約メッセージ

予約メッセージ状態の照会

メッセージの送信予約状態を照会します。

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

{
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}

レスポンス Status

予約メッセージのキャンセル

メッセージの送信予約をキャンセルします。

DELETE https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

なし

レスポンス Status

カカオトークチャンネル

チャンネル照会

カカオトークチャンネルを照会します。

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/channels

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Parameters

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

[
    {
        "createTime": "string",
        "updateTime": "string",
        "serviceId": "string",
        "channelId": "string",
        "channelName": "string",
        "channelStatus": "string",
        "useSmsFailover": "boolean"
    }
]

レスポンス Status

画像

画像のアップロード

友達トークの送信に使用する画像をアップロードします。
画像は1年間保管し、それ以降は自動削除されるため使用できません。

リクエスト URL

POST https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images

Content-Type: multipart/form-data; boundary=a29b1180-70f5-42f7-afbe-0d68a15f2370
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Parameter

レスポンス Body

{
    "imageId":"string",
    "imageName":"string",
    "imageUrl":"string",
    "isWide":"boolean",
    "createTime":"string"
}

レスポンス Status

画像リストの照会

アップロードされた画像リストを照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

Parameters

リクエスト Body

なし

レスポンス Body

{
  "items": [
    {
      "imageId": "string",
      "imageName": "string",
      "imageUrl": "string",
      "isWide": "boolean",
      "createTime": "string"
    }
  ],
  "pageIndex": "integer",
  "pageSize": "integer",
  "itemCount": "integer",
  "totalCount": "integer"
}

レスポンス Status

画像の個別照会

アップロードされた画像を個別照会します。

リクエスト URL

GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images/{imageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

{
    "imageId":"string",
    "imageName":"string",
    "imageUrl":"string",
    "isWide":"boolean",
    "createTime":"string"
}

画像データ

レスポンス Status

画像の削除

アップロードされた画像を削除します。

リクエスト URL

DELETE https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images/{imageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Headerに移動する

リクエスト Body

なし

レスポンス Body

なし

レスポンス Status

エラーコード

bizメッセージの受信結果コード