MENU
      Login
          Login
          目次 x
          友達トーク API
            目次

            友達トーク API

              記事の要約

              基本情報

              API URL

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

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

              API Header

              項目Mandatory説明
              Content-TypeMandatoryリクエスト Body Content Typeを application/jsonに指定(POST)
              x-ncp-apigw-timestampMandatory1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの
              API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
              x-ncp-iam-access-keyMandatoryポータルまたは Sub Accountが発行した Access Key ID
              x-ncp-apigw-signature-v2Mandatory上記例の BodyをAccess Key IDとマッピングする SecretKeyで暗号化した署名
              HMAC暗号化アルゴリズムは、HmacSHA256を使用

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

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

              Headers

              API Headerに移動する

              リクエストボディ

              {
    "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"
}
              JSON
              項目MandatoryType説明備考
              plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              messagesMandatoryObjectメッセージ情報以下の項目を参照(messages.XXX)
              最大100個
              messages.isAdOptionalBoolean広告メッセージの有無デフォルト: true
              広告メッセージとして送信する場合(isAd: true)、
              SMS Failoverが動作する場合、広告メッセージ送信表記の義務を遵守する必要があります。
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者番号
              messages.contentMandatoryString友達トークメッセージの内容
              messages.buttonsOptionalArray of Object友達トークメッセージボタンボタン情報を参照
              messages.buttons.typeMandatoryStringボタンType以下のテンプレートボタン情報を参照
              messages.buttons.nameMandatoryStringボタン名以下のテンプレートボタン情報を参照
              messages.imageOptionalObject画像情報画像のアップロードを参照
              messages.image.imageIdMandatoryStringアップロードされた画像 ID
              messages.image.imageLinkMandatoryString画像リンク
              messages.useSmsFailoverOptionalBooleanSMS Failover使用の有無Failoverが設定されたカカオトークチャンネルでのみ使用可能
              デフォルト: カカオトークチャンネルの Failover設定の有無による
              messages.failoverConfigOptionalObjectFailover設定以下の項目を参照
              messages.failoverConfig.typeOptionalStringFailover SMSメッセージの TypeSMS or LMS
              デフォルト: contentの長さに応じて自動適用 (90bytes以下は SMS、超過は LMS)
              messages.failoverConfig.fromOptionalStringFailover SMSの発信番号デフォルト: Failoverを設定する時に選択した発信番号
              承認されていない発信番号を使用すると、Failoverは動作しない
              messages.failoverConfig.subjectOptionalStringFailover SMSの件名LMS typeとして動作するときに使用
              デフォルト: カカオトークチャンネル名
              messages.failoverConfig.contentOptionalStringFailover SMSの内容デフォルト: 友達トークメッセージの内容(ボタンを除く)
              reserveTimeOptionalString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
              reserveTimeZoneOptionalString予約日時のタイムゾーン予約日時のタイムゾーン(デフォルト: Asia/Seoul)
              *サポートタイムゾーンリスト
              * TZ database nameの値を使用
              • リクエスト Bodyの Mandatoryフィールドを利用する場合、スペースは使用できません (追加する場合に限る)。
              • SMS FailoverはBizMessage受信結果コードに照らして成功でない場合に動作します。prefixとして Bがついたコードの場合は failover機能による SMS代替送信は行われません。
              StatusError textDesc
              0000-正常に送信
              3022NoSendAvailableTimeExceptionメッセージが送信可能な時間ではない(友達トーク/マーケティングメッセージは08時~20時50分まで送信可能)
              Bxxx下記の BizMessage受信結果コードを参照下記の BizMessage受信結果コードを参照
              • 広告メッセージの送信時、SMS Failoverに設定された SMSサービスの080受信拒否サービスを使用します。
                • 設定された SMSサービスに080受信拒否サービスが利用可能な状態でない場合、SMS Failoverは失敗します。
                • failoverConfig.contentを別途指定せずに使用する場合、SMS Failover時に自動的に広告表記文言を挿入します。
                  [広告]{メッセージ内容}
無料受信拒否番号08012345678
                  Plain text
                • failoverConfig.contentを直接別途指定する場合、広告表記文言は挿入しません。広告メッセージの送信時に直接追加してください。
                • 広告表示義務を遵守していない SMSメッセージを送信した場合、後日疎明が必要になる場合があります。
              • ワイド画像送信の場合、テキスト + リンクボタン(1個) + 画像を送信できます。
                • 2つ以上のボタンを追加するとメッセージ送信に失敗します (無効なパラメータリクエスト)。
                • テキストの文字数は76文字に制限されます。

              ボタン情報

              TypeNameMandatory項目
              WLウェブリンクlinkMobile、linkPc (http://または https://で始まる URL)
              ALアプリリンクschemeIos, schemeAndroid
              BKボットキーワード
              MDメッセージの伝達
              ACチャンネルの追加

              レスポンスボディ

              {
    "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"
        }
    ]
}
              JSON
              項目MandatoryType説明備考
              requestIdMandatoryString送信リクエスト ID
              requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              statusCodeMandatoryStringリクエスト状態コード202 - 成功
              その他 - 失敗
              * HTTP Status規格に従う
              statusNameMandatoryStringリクエスト状態名success - 成功
              processing - 処理中
              reserved - 予約中
              fail - 失敗
              messages.messageIdMandatoryStringメッセージ ID
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者番号
              messages.contentMandatoryString友達トークメッセージの内容
              messages.requestStatusCodeMandatoryString送信リクエスト状態コードA000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messages.requestStatusNameMandatoryString送信リクエスト状態名success - 成功
              fail - 失敗
              messages.requestStatusDescMandatoryString送信リクエスト状態の内容
              messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無

              レスポンスステータス

              HTTP StatusDesc
              202Accepted(送信リクエスト完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

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

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

              リクエスト 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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

              Parameters

              項目MandatoryType説明備考
              requestIdMandatoryStringリクエスト ID送信リクエスト ID
              plusFriendIdMandatoryStringカカオチャンネル登録されたチャンネル名
              requestStartTimeMandatoryString照会時間の開始時刻yyyy-MM-dd'T'HH:mm:ss
              requestEndTimeMandatoryString照会時間の終了時刻yyyy-MM-dd'T'HH:mm:ss
              completeStartTimeMandatoryString送信完了の開始時間yyyy-MM-dd'T'HH:mm:ss
              completeEndTimeMandatoryString送信完了の終了時間yyyy-MM-dd'T'HH:mm:ss
              messageIdOptionalStringメッセージ ID
              requestStatusNameOptionalStringリクエスト状態success, fail
              messageStatusNameOptionalStringリクエスト状態success, processing, fail
              toOptionalStringメッセージ受信番号ハイフン「-」を除く番号
              pageIndexOptionalIntegerページ番号デフォルト: 0
              pageSizeOptionalIntegerページサイズデフォルト: 20, 最大: 100
              requestIdを含めて照会する場合、デフォルト: 100
              参考
              • メッセージの送信履歴は直近30日以内の履歴のみ照会できます。
              • requestId、requestStartTime + requestEndTime、completeStartTime + completeEndTimeのうち少なくとも1つは必須です。
              • requestStartTime + requestEndTimeと completeStartTime + completeEndTimeは同時には使用できません。
              • requestStartTime ~ requestEndTimeの照会範囲は最大31日に制限されます。
              • completeStartTime ~ completeEndTimeの照会範囲は最大24時間に制限されます。
              • 照会条件に requestIdが含まれていない場合、plusFriendIdは必須です。

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
    "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"
}
              JSON
              項目MandatoryType説明備考
              requestIdOptionalString送信リクエスト IDrequestIdで照会する場合にのみ表示
              statusCodeMandatoryStringリクエスト状態コード202 - 成功
              その他 - 失敗
              * HTTP Status規格に従う
              statusNameMandatoryStringリクエスト状態名success - 成功
              processing - 送信中
              reserved - 予約中
              fail - 失敗
              messages.requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              messages.messageIdMandatoryStringメッセージ ID
              messages.countryCodeOptionalString受信者の国番号デフォルト: 82
              messages.toMandatoryString受信者番号
              messages.contentMandatoryString友達トークメッセージの内容
              messages.plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              messages.completeTimeOptionalDateTime送信レポート(処理完了)時間yyyy-MM-dd'T'HH:mm:ss
              messages.requestStatusCodeMandatoryString送信リクエスト状態コードA000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messages.requestStatusNameMandatoryString送信リクエスト状態名success - 成功
              fail - 失敗
              messages.requestStatusDescMandatoryString送信リクエスト状態の内容
              messages.messageStatusCodeMandatoryString送信結果状態コード0000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messages.messageStatusNameMandatoryString送信結果状態名success - 成功
              processing - 処理中
                  * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
                  * messageCode、messageDescが照会されていない
              fail - 失敗
              messages.messageStatusDescMandatoryString送信結果状態の内容
              messages.isWideMandatoryBooleanワイドの有無
              messages.isAdMandatoryBoolean広告メッセージの有無
              messages.useSmsFailoverMandatoryBooleanSMS Failover使用の有無
              messages.failoverOptionalObjectSMS Failover
              messages.failover.smsServiceIdOptionalStringSMS Failoverのサービス ID
              messages.failover.requestIdOptionalStringSMS Failoverの送信リクエスト ID
              messages.failover.messageIdOptionalStringSMS Failoverの送信メッセージ ID
              messages.failover.requestStatusCodeOptionalStringSMS Failoverの送信リクエスト状態コードエラーコード表を参考
              messages.failover.requestStatusNameOptionalStringSMS Failoverの送信リクエスト状態名success - 成功
              fail - 失敗
              messages.failover.requestStatusDescOptionalStringSMS Failoverの送信リクエスト状態の内容
              messages.failover.messageStatusOptionalStringSMS Failoverの送信処理状態READY: 待機
              PROCESSING: 処理中
              COMPLETED: 処理完了
              messages.failover.messageStatusCodeOptionalStringSMS Failover送信端末の受信状態結果コードエラーコード表を参考
              messages.failover.messageStatusNameOptionalStringSMS Failover送信端末の受信結果名
              messages.failover.messageStatusDescOptionalStringSMS Failover送信端末の受信内容
              pageSizeMandatoryIntegerページサイズ
              pageIndexMandatoryIntegerページのインデックス(0からスタート)
              itemCountMandatoryInteger照会結果ページ内のメッセージ数
              hasMoreMandatoryBoolean次のページの存在有無

              レスポンスステータス

              HTTP StatusDesc
              200OK(照会完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

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

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

              リクエスト 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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              messageIdMandatoryStringメッセージ IDメッセージ送信時に返されるメッセージ識別子

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
    "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"
    }
}
              JSON
              項目MandatoryType説明備考
              messageIdMandatoryStringメッセージ ID
              requestIdMandatoryString送信リクエスト ID
              requestTimeMandatoryDateTime送信リクエスト時間yyyy-MM-dd'T'HH:mm:ss.SSS
              completeTimeOptionalDateTime送信レポート(処理完了)時間yyyy-MM-dd'T'HH:mm:ss
              plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              templateCodeMandatoryStringテンプレートコード
              countryCodeOptionalString受信者の国番号デフォルト: 82
              toMandatoryString受信者番号
              contentMandatoryString友達トークメッセージの内容
              requestStatusCodeMandatoryString送信リクエスト状態コードA000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              requestStatusNameMandatoryString送信リクエスト状態名success - 成功
              fail - 失敗
              requestStatusDescMandatoryString送信リクエスト状態の内容
              messageStatusCodeMandatoryString送信結果状態コード0000 - 成功
              その他のコード - 失敗(Desc項目に失敗理由が明示される)
              messageStatusNameMandatoryString送信結果状態名success - 成功
              processing - 処理中
                  * 送信リクエスト成功後、メッセージ送信サーバで処理中の状態
                  * messageCode、messageDescが照会されていない
              fail - 失敗
              messageStatusDescMandatoryString送信結果状態の内容
              isWideMandatoryBooleanワイドの有無
              isAdMandatoryBoolean広告メッセージの有無
              imageIdOptionalString画像 ID
              imageNameOptionalString画像名
              imageUrlOptionalString画像URL
              imageLinkOptionalString画像リンク
              useSmsFailoverMandatoryBooleanSMS Failover使用の有無
              failoverOptionalObjectSMS Failover使用の有無
              failover.smsServiceIdOptionalStringSMS Failoverのサービス ID
              failover.requestIdOptionalStringSMS Failoverの送信リクエスト ID
              failover.requestStatusCodeOptionalStringSMS Failoverの送信リクエスト状態コードエラーコード表を参考
              failover.requestStatusNameOptionalStringSMS Failoverの送信リクエスト状態名success - 成功
              fail - 失敗
              failover.requestStatusDescOptionalStringSMS Failoverの送信リクエスト状態の内容
              failover.messageIdOptionalStringSMS Failoverの送信メッセージ ID
              failover.messageStatusOptionalStringSMS Failoverの送信処理状態READY: 待機
              PROCESSING: 処理中
              COMPLETED: 処理完了
              failover.messageStatusCodeOptionalStringSMS Failover送信端末の受信状態結果コードエラーコード表を参考
              failover.messageStatusNameOptionalStringSMS Failover送信端末の受信結果名
              failover.messageStatusDescOptionalStringSMS Failover送信端末の受信内容

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

              requestStatusCodeDesc
              0成功
              E4000failover設定が有効ではない
              E4001failover設定の情報が抜けている
              E4002failover SMSサービスが設定されていない
              E4003failover SMS type(SMS、LMS)が設定されていない
              E4004failover SMSの発信番号が設定されていない
              E4005failover SMSの件名が設定されていない
              E4006failover SMSの内容が設定されていない
              E4007failover SMSの受信番号が設定されていない
              E4008failover SMSサービスが使用可能な状態ではない
              E4009failover SMSの発信番号が認証されていない
              E4010failover SMS 080無料受信拒否サービスが使用可能な状態ではない
              E4999failover設定のパースエラー(サポートセンターに要相談)
              E5000内部エラー(サポートセンターに要相談)

              レスポンスステータス

              HTTP StatusDesc
              200OK(照会完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              予約メッセージ

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

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

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

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}
              JSON
              項目MandatoryType説明備考
              reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)
              reserveTimeMandatoryString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
              reserveTimeZoneMandatoryString予約日時のタイムゾーン予約日時のタイムゾーン(デフォルト: Asia/Seoul)
              *サポートタイムゾーンリスト
              * TZ database nameの値を使用
              reserveStatusMandatoryString予約の状態READY - 送信待ち
              PROCESSING - 送信リクエスト中
              CANCELED - 送信キャンセル
              FAIL - 送信リクエスト失敗
              DONE - 送信リクエスト成功
              STALE - 送信リクエスト失敗 (時間オーバー)

              レスポンスステータス

              HTTP StatusDesc
              200OK(照会完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

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

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

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

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              なし
              JSON

              レスポンスステータス

              HTTP StatusDesc
              204No Content(削除完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              カカオトークチャンネル

              チャンネルの照会

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

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

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

              Parameters

              項目MandatoryType説明備考
              pageSizeOptionalIntegerページサイズデフォルト: 100 (1~100までの数字のみ入力可能)
              pageIndexOptionalIntegerページインデックスデフォルト: 0

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              [
    {
        "createTime": "string",
        "updateTime": "string",
        "serviceId": "string",
        "channelId": "string",
        "channelName": "string",
        "channelStatus": "string",
        "useSmsFailover": "boolean"
    }
]
              JSON
              項目MandatoryType説明備考
              createTimeMandatoryString作成時間format: LocalDateTime
              updateTimeOptionalString更新時間format: LocalDateTime
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              channelIdMandatoryStringカカオトークチャンネル ID
              channelNameMandatoryStringカカオトークチャンネル名
              channelStatusMandatoryStringカカオトークチャンネルの状態- 正常: ACTIVE
              - 削除: DELETED
              - 完全削除中: DELETING_PERMANENTLY
              - 完全削除: PERMANENTLY_DELETED
              - ブロック: BLOCKED
              - 削除遅延中: PENDING_DELETE
              useSmsFailoverMandatoryBooleanSMS代替送信を使用するか否か

              レスポンスステータス

              HTTP StatusDesc
              200OK
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              429Too Many Requests
              500Internal Server Error

              画像

              イメージのアップロード

              友達トークの送信に使用する画像をアップロードします。
              画像は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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

              Headers

              API Headerに移動する

              リクエストパラメータ

              項目MandatoryType説明備考
              plusFriendIdMandatoryStringカカオトークチャンネル名((旧)プラス友達 ID)
              imageFileMandatoryFile画像ファイル- 共通
              * jpg、pngのみ対応
              * 500KB以下
              - 一般
              * 推奨サイズ: 720px x 720px
              * 横500px以上、横 * 縦比が2:1以上で3:4以下の場合にのみアップロード可能
              - ワイド
              * 制限サイズ: 800px x 600px
              * 横 * 縦比が4:3の場合にのみアップロード可能
              isWideOptionalBooleanワイド画像の有無ワイド画像をアップロードする時、ワイド友達トークメッセージとして送信される
              * defealt: false

              レスポンスボディ

              {
    "imageId":"string",
    "imageName":"string",
    "imageUrl":"string",
    "isWide":"boolean",
    "createTime":"string"
}
              JSON
              項目MandatoryType説明備考
              imageIdMandatoryStrng画像 ID
              imageNameMandatoryString画像ファイル名
              imageUrlMandatoryString画像URL
              isWideMandatoryBooleanワイドの有無
              createTimeMandatoryDateTime画像をアップロードした日時

              レスポンスステータス

              HTTP StatusDesc
              200OK (アップロード完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              イメージリストの照会

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

              リクエスト 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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

              Headers

              API Headerに移動する

              Parameters

              項目MandatoryType説明備考
              pageIndexOptionalIntegerページインデックスデフォルト: 0
              pageSizeOptionalIntegerページサイズデフォルト: 20 (1~100以内の数字のみ入力可能)

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              {
  "items": [
    {
      "imageId": "string",
      "imageName": "string",
      "imageUrl": "string",
      "isWide": "boolean",
      "createTime": "string"
    }
  ],
  "pageIndex": "integer",
  "pageSize": "integer",
  "itemCount": "integer",
  "totalCount": "integer"
}
              JSON
              項目MandatoryType説明備考
              itemsMandatoryArray of Object画像データリスト画像データを参照
              pageIndexMandatoryIntegerページインデックス
              pageSizeMandatoryIntegerページサイズ
              itemCountMandatoryInteger照会結果のアイテム数
              totalCountMandatoryInteger総数

              レスポンスステータス

              HTTP StatusDesc
              200OK (照会完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              画像の個別照会

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

              リクエスト 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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              imageIdMandatoryString画像 IDアップロードされた画像 ID

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

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

              画像データ

              項目MandatoryType説明備考
              imageIdMandatoryStrng画像 ID
              imageNameMandatoryString画像ファイル名
              imageUrlMandatoryString画像URL
              isWideMandatoryBooleanワイドの有無
              createTimeMandatoryDateTime画像をアップロードした日時

              レスポンスステータス

              HTTP StatusDesc
              200OK (照会完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              イメージの削除

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

              リクエスト 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}
              HTTP

              Path Variables

              項目MandatoryType説明備考
              serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
              imageIdMandatoryString画像 IDアップロードされた画像 ID

              Headers

              API Headerに移動する

              リクエストボディ

              なし
              JSON

              レスポンスボディ

              なし
              JSON

              レスポンスステータス

              HTTP StatusDesc
              204No Content(削除完了)
              400Bad Request
              401Unauthorized
              403Forbidden
              404Not Found
              500Internal Server Error

              エラーコード

              BizMessageの受信結果コード

              StatusError textDesc
              0000-正常に送信
              1001NoJsonBodyRequest Bodyが JSON形式ではない
              1002InvalidHubPartnerKeyパートナーキーが有効ではない
              1003InvalidSenderKey送信プロファイルキーが有効ではない
              1004NoValueJsonElementRequest BODY(JSON)で nameが見つからない
              1005SenderNotFound送信プロファイルが見つからない
              1006DeletedSender削除された送信プロファイル
              1007StoppedSenderブロック状態の送信プロファイル
              1011ContractNotFound契約情報が見つからない
              1012InvalidUserKeyException正しくない形式のユーザーキーリクエスト
              1013InvalidAppLink有効ではないアプリリンク
              1014InvalidBizNum有効ではない事業者番号
              1015TalkUserIdNotFonud有効でないアプリユーザー IDリクエスト
              1016BizNumNotEqual事業者登録番号の不一致
              1020InvalidReceiveUserException有効なユーザー識別子の値がまったくない場合
              1021BlockedProfileブロック状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1022DeactivatedProfile非活性状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1023DeletedProfile削除されたカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1024DeletingProfile削除待ち状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1025SpammedProfileメッセージブロック状態のカカオトークチャンネル(カカオトークチャンネル運用ツールで確認)
              1026UnableUseMessageTypemsg_typeで使用できない response_methodでリクエスト(画像通知トーク(AI)はリアルタイムで送信不可)
              1027-チャンネルメッセージ制裁状態によるメッセージ送信失敗
              1030InvalidParameterException正しくないパラメータリクエスト
              1033-テンプレートタイプとメッセージタイプが一致しない
              2000FailedToCheckFriendshipExceptionトークチャンネルとの友達関係確認時のエラー(システムエラー)
              2003FailedToSendMessageByNoFriendshipExceptionメッセージの送信失敗 (テストサーバでカカオトークチャンネルを追加していない場合)
              2004FailedToMatchTemplateExceptionテンプレートと一致してるかどうかを確認中にエラー発生 (カカオトークの内部エラー)
              2005FailedToReadImageExceptionカカオから画像のメタ情報を読み込み中にエラー
              2006FailedToMatchSerialNumberPrefixPatternシリアル番号形式の不一致
              3000UnexceptedExcetpion予期せぬエラーの発生
              3005AckTimeoutExceptionメッセージを送信したが、受信が確認できてない(成否が不明)
              3006FailedToSendMessageExceptionカカオトーク内部システムエラーによるメッセージ送信失敗
              3008InvalidPhoneNumberException電話番号エラー
              3010JsonParsseExcetpionJSONパースエラー
              3011MessageNotFoundExceptionメッセージが存在しない
              3012SerialNumberDuplicatedExceptionメッセージのシリアル番号が重複している(メッセージのシリアル番号は固有の値でなければならない)
              3013MessageEmptyException空のメッセージ
              3014MessageLengthOverLimitExceptionメッセージの長さ制限エラー(テキストタイプ1000文字をオーバー、画像タイプ400文字をオーバー)
              3015TemplateNotFoundExceptionテンプレートが見つからない
              3016NoMatchedTemplateExceptionメッセージ内容がテンプレートと一致しない
              3018NoSendAvailableExceptionメッセージを送信できない
              3019MessageNoUserExceptionトークのユーザーではない
              3020MessageUserBlockedAlimTalkException通知トークブロック
              3021MessageNotSupportedKakaotalkExceptionトークの最低バージョンをサポートしない
              3022NoSendAvailableTimeExceptionメッセージが送信可能な時間ではない(友達トーク/マーケティングメッセージは08時~20時まで送信可能)
              3023MessageInvalidVideoExceptionメッセージに含まれるビデオを送信できない(ビデオのアドレスまたはサムネイル画像アドレスが正しくないか、サムネイル画像が規格に合わない)
              3024MessageInvaildImageExceptionメッセージに含まれた画像を送信できない
              3025ExceedMaxVariableLengthException変数の文字数制限を超過
              3026Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})'相談/ボット切り替えボタン extra、event文字数の制限を超過
              3027NoMatchedTemplateButtonExceptionボタンの内容がテンプレートと一致しない
              3028NoMatchedTemplateTitleExceptionメッセージの強調表記件名がテンプレートと一致しない
              3029ExceedMaxTitleLengthExceptionメッセージの強調表記件名の長さが制限を超過(50文字)
              3031-テキストタイプの不一致
              3030NoMatchedTemplateWithMessageTypeExceptionメッセージタイプやテンプレートの強調タイプが一致しない
              3031NoMatchedTemplateHeaderExceptionヘッダがテンプレートと一致しない
              3032ExceedMaxHeaderLengthExceptionヘッダの長さ制限を超過(16文字)
              3033NoMatchedTemplateItemHighlightExceptionアイテムハイライトがテンプレートと一致しない
              3034ExceedMaxItemHighlightTitleLengthExceptionアイテムハイライトの件名の長さが制限を超過(画像がない場合は30文字、画像がある場合は21文字)
              3035ExceedMaxItemHighlightDescriptionLengthExceptionアイテムハイライトの説明の長さが制限を超過(画像がない場合は19文字、画像がある場合は14文字)
              3036NoMatchedTemplateItemListExceptionアイテムリストがテンプレートと一致しない
              3037ExceedMaxItemDescriptionLengthExceptionアイテムリストのアイテムの説明の長さが制限を超過(23文字)
              3038NoMatchedTemplateItemSummaryExceptionアイテムのサマリー情報がテンプレートと一致しない
              3039ExceedMaxItemSummaryDescriptionLengthExceptionアイテムサマリー情報の説明の長さが制限を超過(14文字)
              3040InvalidItemSummaryDescriptionExceptionアイテムのサマリー情報の説明が有効でない文字を含む(通貨記号/コード、数字、コンマ、小数点、スペースを除いた文字を含む)
              3041MessageInvalidWideItemListLengthExceptionワイドアイテムリスト数の最小値と最大値が一致しない
              3042NoMatchedTemplateRepresentLinkException代表リンクがテンプレートと一致しない
              3046ExceedMaxAdditionalContentLengthException付加情報の最大長さ制限エラー
              3047ExceedMaxCommerceTitleLengthExceptionコマース情報、商品名の最大長さ制限エラー
              3050MessageNotSupportedUnsubscribeException受信同意拒否スペック(Nタイプ)をサポートしない
              3051InvalidateCarouselItemMinException or InvalidateCarouselItemMaxExceptionカルーセルアイテムリスト数の最小値と最大値が一致しない
              3052CarouselMessageLengthOverLimitExceptionカルーセルアイテムメッセージが長さ制限を超過
              3056WideItemListTitleLengthOverLimitExceptionワイドアイテムリストタイトルの長さ制限エラー
              3058CarouselHeaderLengthOverLimitExceptionカルーセルヘッダの長さ制限エラー
              3059MessageNotSupportedCouponExceptionクーポンのスペックをサポートしない
              4000ResponseHistoryNotFoundExceptionメッセージ送信結果が見つからない
              4001UnKnownMessageStatusError不明なメッセージ状態
              7011-シリアル番号パターンのエラー
              7014-メッセージ有効時間のオーバーエラー
              8512-受信者タイプが見つからない
              8514-request_idが見つからない
              8520-サポートしない商品タイプエラー
              8521-サポートしないメッセージタイプエラー
              8522-サポートしないテキストタイプエラー
              8523-サポートしない response methodエラー
              8530-受信者リストサイズエラー
              8999-内部サーバエラー
              9998現在サービスを提供していません。システムにトラブルが発生し、担当者が確認中
              9999システムに原因不明のトラブルが発生し、担当者が確認中システムにトラブルが発生し、担当者が確認中
              B000Prepare to relay failed中継会社への送信のための事前作業に失敗
              B001Request to relay failed中継会社への送信失敗
              B002Filtering for request to relay failed無効なリクエストによりフィルタリングされる
              B003Invalid phone number format無効な発信番号形式
              B004Quota Exceedクォーター超過
              B005Message processing timeout exceedメッセージのリクエスト時間と処理時間の差が許容範囲外である
              B400Invalid Requestメッセージ形式エラー
              B999Unexpected server error予期せぬエラー
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              First name must have atleast 2 characters. Numbers and special characters are not allowed.
              Last name must have atleast 1 characters. Numbers and special characters are not allowed.
              Enter a valid email
              Enter a valid password
              Your profile has been successfully updated.
              Logout