GET/cxtalk/contact-tags

CXトークの連絡先タグリストを取得する。

  • 既定では、タグ名で昇順ソートされます。

Authorization

oauth2

Access Token を指定します。 指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

cxtalk
cxtalk.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/cxtalk/contact-tags

Query Parameters

ParameterTypeDescription
orderBy string 

ソート対象

  • name : 名前
    並び順
  • asc : 昇順 (既定)
  • desc : 降順
    ソートフィールドと並び順はスペースで区切る (separator : %20)

example : name%20asc 
count integer 

取得数


default : 100
minimum : 1
maximum : 500
example : 100
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

CXトーク 連絡先タグリストレスポンス

PropertyTypeDescription
contactTags array (CxTalkContactTag) 

CXトーク 連絡先タグ情報

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

CxTalkContactTag

PropertyTypeDescription
contactTagId string 

CXトーク 連絡先タグ ID


readOnly : true 
contactTagName string 

タグ名


required
minLength : 1
maxLength : 30 
userId string 

タグを作成したユーザー ID


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "contactTags": [3    {4      "contactTagId": "ctag2a81-94b6-4642-6903-03aa7977da91",5      "contactTagName": "商品問い合せ",6      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"7    },8    {9      "contactTagId": "ctag3b92-a5c7-5753-7a14-04bb8088eb02",10      "contactTagName": "VIP顧客",11      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"12    }13  ],14  "responseMetaData": {15    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="16  }17}

HTTP 400

Bad Request

HTTP 403

Forbidden