従業員の作成
POST /v1/user
リクエストパラメータ
| パラメータ |
タイプ |
必須 |
説明 |
| email |
文字列 |
はい |
メールアドレス。有効なメールアドレス形式である必要があります。 |
| password |
文字列 |
はい |
パスワード。 |
| jobStatus |
整数型 |
いいえ |
在職ステータス。0：退職；1：在職。 |
| agentType |
整数型 |
いいえ |
オペレータタイプ。1：通常オペレータ；2：電話オペレータ。 |
| agentRole |
文字列 |
いいえ |
電話オペレータの役割。agent：通常電話オペレータ； leader：リーダー |
| realname |
文字列 |
はい |
氏名。最大32文字。 |
| mobile |
文字列 |
いいえ |
携帯電話番号。正規表現 ^1[3-9]\d{9}$ の形式を満たす必要があります。 |
| position |
オブジェクト |
はい |
ポジション。 |
| position.id |
整数型 |
はい |
ポジションID。 |
| userGroupList |
整数型配列 |
いいえ |
所属従業員グループIDリスト。 |
| roleList |
配列 |
はい |
ロールリスト。 |
| roleList[].id |
整数型 |
はい |
ロールID。 |
| userInfo |
オブジェクト |
いいえ |
従業員拡張情報 |
| userInfo.id |
整数型 |
いいえ |
拡張情報ID |
レスポンスデータ
| 属性名 |
タイプ |
説明 |
| code |
整数型 |
レスポンスコード。 |
| message |
文字列 |
レスポンスメッセージ。 |
| visible |
ブール型 |
可視性。true / false。 |
| data |
オブジェクト |
ビジネスオブジェクト。 |
| data.id |
整数型 |
従業員ID。 |
| data.email |
文字列 |
メールアドレス。 |
| data.jobStatus |
整数型 |
在職ステータス。0：退職；1：在職。 |
| data.agentType |
整数型 |
オペレータタイプ。1：通常オペレータ；2：電話オペレータ。 |
| data.agentRole |
文字列 |
電話オペレータの役割。agent：通常電話オペレータ； leader：リーダー。 |
| data.position |
オブジェクト |
ポジション。 |
| data.position.id |
整数型 |
ポジションID。 |
| data.userGroupList |
整数型配列 |
所属従業員グループIDリスト。 |
| data.realname |
文字列 |
氏名。 |
| data.mobile |
文字列 |
携帯電話番号。 |
| data.roleList |
配列 |
ロール配列。 |
| data.roleList[].id |
整数型 |
ロールID。 |
| data.authorizationSetList |
配列 |
権限セット配列。 |
| data.authorizationSetList[].id |
整数型 |
権限セットID。 |
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
"email" : "1@test.cn",
"password" : "sJrKTUpSx",
"realname" : "テスト従業員1",
"mobile" : "13300000001",
"position" : {
"id" : 2
},
"userGroupList": [533,544],
"roleList" : [ {
"id" : 3
} ],
"userInfo":{
"id" : 2
}
}'
レスポンス例
{
"code" : 200,
"message" : "OK",
"visible" : false,
"data" : {
"id" : 942,
"email" : "1@test.cn",
"position" : {
"id" : 2
},
"realname" : "テスト従業員1",
"mobile" : "13300000001",
"roleList" : [ {
"id" : 3
} ],
"userGroupList": [533,544],
"authorizationSetList" : [ ]
}
}
従業員を更新する
PUT /v1/user/{id:^[1-9]\d*$}
埋め込みリクエストパラメータ
| パラメータ |
タイプ |
必須 |
説明 |
制限 |
| id |
整数型 |
はい |
ID. |
1より大きい必要があります |
リクエストパラメータ
| パラメータ |
タイプ |
必須 |
説明 |
| realname |
文字列 |
はい |
氏名. |
| mobile |
文字列 |
いいえ |
携帯電話。形式regular expression ^1[3-9]\d{9}$に準拠する必要があります。 |
| jobStatus |
整数型 |
いいえ |
在職ステータス。0：退職；1：在職. |
| agentType |
整数型 |
いいえ |
エージェントタイプ。1：通常エージェント；2：電話エージェント. |
| agentRole |
文字列 |
いいえ |
電話エージェントロール。agent：通常電話エージェント； leader：リーダー |
| position |
オブジェクト |
はい |
ポジション. |
| position.id |
整数型 |
はい |
ポジションID |
| status |
整数型 |
いいえ |
ステータス: 1有効; 2無効; 3審査中. |
| userGroupList |
整数型配列 |
いいえ |
所属従業員グループIDリスト. |
| roleList |
配列 |
はい |
ロール. |
| roleList[].id |
整数型 |
はい |
ロールID. |
| userInfo |
オブジェクト |
いいえ |
従業員拡張情報 |
| userInfo.id |
整数型 |
いいえ |
拡張情報ID |
レスポンスデータ
| 属性名 |
タイプ |
説明 |
| code |
整数型 |
レスポンスコード. |
| message |
文字列 |
レスポンスメッセージ. |
| visible |
ブール型 |
可視性. true / false . |
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/user/944?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
"realname" : "テスト従業員1",
"mobile" : "13300000001",
"position" : {
"id" : 2
},
"status" : 1,
"roleList" : [ {
"id" : 2
} ],
"userGroupList": [533,544],
"userInfo":{
"id" : 2
}
}'
レスポンス例
{
"code" : 200,
"message" : "OK",
"visible" : false
}
従業員を検索する
GET /v1/user/{id:^[1-9]\d*$}
埋め込みリクエストパラメータ
| パラメータ |
タイプ |
必須 |
説明 |
制限 |
| id |
整数型 |
はい |
従業員ID |
1より大きい必要があります |
レスポンスデータ
| 属性名 |
タイプ |
説明 |
| code |
整数型 |
レスポンスコード. |
| message |
文字列 |
レスポンスメッセージ. |
| visible |
ブール型 |
可視性. true / false . |
| data |
オブジェクト |
ビジネスオブジェクト. |
| data.id |
整数型 |
従業員ID. |
| data.email |
文字列 |
メールアドレス. |
| data.position |
オブジェクト |
ポジション. |
| data.position.id |
整数型 |
ポジションID. |
| data.userGroupList |
整数型配列 |
所属従業員グループIDリスト. |
| data.realname |
文字列 |
氏名. |
| data.mobile |
文字列 |
携帯電話番号. |
| data.jobStatus |
整数型 |
在職ステータス。0：退職；1：在職 |
| data.agentType |
整数型 |
エージェントタイプ：1，通常エージェント；2，電話エージェント. |
| data.agentRole |
文字列 |
エージェントロール：agent,通常； leader，リーダー. |
| data.roleList |
配列 |
ロール. |
| data.roleList[].id |
整数型 |
ロールID. |
| data.authorizationSetList |
配列 |
権限セット. |
| data.authorizationSetList[].id |
整数型 |
権限セットID. |
| data.userInfo |
オブジェクト |
従業員拡張詳細情報. |
| data.userInfo.dataId |
整数型 |
dataID. |
| data.userInfo.objectId |
整数型 |
従業員拡張情報レコードID. |
| data.userInfo.userInfoName |
文字列 |
データ表示名(主フィールド値の冗長). |
| data.userInfo.fieldDataList |
配列 |
フィールド情報リスト。返されるフィールドは、「人員管理」 -> 「従業員管理」 -> 「個人情報設定」で追加されたフィールドに基づいて返されます。 |
| data.userInfo.fieldDataList[].fieldApiName |
文字列 |
フィールドAPI名称. |
| data.userInfo.fieldDataList[].fieldTypeApiName |
文字列 |
フィールドAPI名称. |
| data.userInfo.fieldDataList[].fieldValue |
文字列 |
フィールド値. |
| data.userInfo.fieldDataList[].foreignDataName |
文字列 |
関連オブジェクトレコード名. |
| data.userInfo.fieldDataList[].userEmail |
文字列 |
関連従業員メールアドレス. |
| data.userInfo.fieldDataList[].optionNameList |
配列 |
オプション名リスト(選択タイプフィールド). |
| data.userInfo.fieldDataList[].tagValueList |
配列 |
タグフィールド詳細情報(電話またはメール). |
| data.userInfo.fieldDataList[].tagValueList[].tagName |
文字列 |
タグ名. |
| data.userInfo.fieldDataList[].tagValueList[].tagValue |
文字列 |
タグ値. |
| data.userInfo.fieldDataList[].richText |
オブジェクト |
リッチテキストフィールド詳細情報(内容および添付ファイル). |
| data.userInfo.fieldDataList[].richText.content |
文字列 |
リッチテキスト内容. |
| data.userInfo.fieldDataList[].richText.attachmentList |
配列 |
添付ファイルリスト. |
| data.userInfo.fieldDataList[].richText.attachmentList[].name |
文字列 |
元のファイル名. |
| data.userInfo.fieldDataList[].richText.attachmentList[].docAddress |
文字列 |
外部リンク. |
| data.userInfo.fieldDataList[].richText.attachmentList[].size |
整数型 |
サイズ. |
| data.userInfo.fieldDataList[].ownerResult |
オブジェクト |
所有者. |
| data.userInfo.fieldDataList[].ownerResult.ownerType |
整数型 |
所有者タイプ. |
| data.userInfo.fieldDataList[].ownerResult.ownerName |
文字列 |
所有者名. |
| data.userInfo.fieldDataList[].signDto |
オブジェクト |
署名情報. |
| data.userInfo.fieldDataList[].signDto.url |
文字列 |
署名画像URL. |
| data.userInfo.fieldDataList[].signDto.time |
文字列 |
署名時間. |
| ##### リクエスト例 |
|
|
$ curl 'https://servicego.udesk.cn/api/v1/user/941?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
"code": 200,
"message": "OK",
"visible": false,
"data": {
"id": 3,
"email": "zhaofeng@Udesk.cn",
"position": {
"id": 2
},
"realname": "張三",
"mobile": "15840134826",
"jobNumber": "88066",
"agentType": 1,
"agentRole": "agent",
"roleList": [
{
"id": 2
}
],
"userGroupList": [533,544],
"authorizationSetList": [],
"userInfo": {
"dataId": 2,
"objectId": 13,
"userInfoName": "テスト",
"fieldDataList": [
{
"fieldApiName": "sysusername",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト1"
},
{
"fieldApiName": "tudi",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト2"
},
{
"fieldApiName": "wuqi",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト3"
},
{
"fieldApiName": "lianxidianhua",
"fieldTypeApiName": "field_type_telephone",
"tagValueList": [
{
"tagName": "携帯電話",
"tagValue": "15840347826"
},
{
"tagName": "携帯電話",
"tagValue": "15844578040"
}
]
}
]
}
}
}
従業員削除
DELETE /v1/user/{ids}
リクエストパラメータ
| パラメータ |
型 |
必須 |
説明 |
| ids |
文字列 |
false |
従業員ID。バッチ削除をサポート。複数従業員の場合はIDを,で連結可能 |
レスポンスデータ
| 属性名 |
型 |
説明 |
| code |
整数型 |
レスポンスコード。 |
| message |
文字列 |
レスポンスメッセージ。 |
| visible |
ブール型 |
可視性, true / false 。 |
| data |
オブジェクト |
ビジネスオブジェクト。 |
| data.successList |
配列 |
削除成功従業員コレクション。 |
| data.successTotal |
整数型 |
削除成功数 |
| data.failMap |
オブジェクト |
削除失敗従業員コレクション。 |
| data.failTotal |
整数型 |
削除失敗数 |
| data.total |
整数型 |
削除成功数 |
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/user/1,2,3?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
"code" : 200,
"message" : "OK",
"visible" : false,
"data" : {
"successList" : [1],
"successTotal" : 1,
"failMap" : {
"2" : "従業員が存在しません",
"3" : "従業員は削除できません"
},
"failTotal" : 2,
"total" : 3
}
}
従業員一覧取得
GET /v1/user
リクエストパラメータ
| パラメータ |
型 |
必須 |
説明 |
| pageNum |
整数型 |
はい |
ページ番号, 最小: 1。 |
| pageSize |
整数型 |
はい |
ページサイズ, 最小: 1, 最大: 100。 |
| positionId |
整数型 |
いいえ |
ポジションID。このパラメータを指定した場合、指定されたポジションに所属する従業員のみを取得します。 |
レスポンスデータ
標準ページングオブジェクトページング
| 属性名 |
型 |
説明 |
| code |
整数型 |
レスポンスコード。 |
| message |
文字列 |
レスポンスメッセージ。 |
| visible |
ブール型 |
可視性, true / false 。 |
| paging |
オブジェクト |
ページングオブジェクト。 |
| paging.pageNum |
整数型 |
ページ番号。 |
| paging.pageSize |
整数型 |
ページサイズ。 |
| paging.total |
整数型 |
ページングクエリの総ヒット数。 |
| data |
配列 |
ビジネスオブジェクト。 |
| data[].id |
整数型 |
従業員ID。 |
| data[].email |
文字列 |
メールアドレス。 |
| data[].position |
オブジェクト |
ポジション。 |
| data[].position.id |
整数型 |
ポジションID。 |
| data[].realname |
文字列 |
氏名。 |
| data[].mobile |
文字列 |
携帯電話番号。 |
| data[].jobStatus |
整数型 |
在職ステータス。0：退職；1：在職 |
| data[].agentType |
整数型 |
エージェントタイプ：1、通常エージェント；2、電話エージェント。 |
| data[].agentRole |
文字列 |
エージェントロール：agent, 通常； leader、リーダー。 |
| data[].roleList |
配列 |
ロール。 |
| data[].roleList[].id |
整数型 |
ロールID。 |
| data[].userGroupList |
整数型配列 |
所属従業員グループIDリスト。 |
| data[].authorizationSetList |
配列 |
権限セット。 |
| data[].authorizationSetList[].id |
整数型 |
権限セットID。 |
| data[].userInfo |
オブジェクト |
従業員拡張詳細情報。 |
| data[].userInfo.dataId |
整数型 |
dataID。 |
| data[].userInfo.objectId |
整数型 |
従業員拡張情報レコードID。 |
| data[].userInfo.userInfoName |
文字列 |
データ表示名（主フィールド値の冗長化）。 |
| data[].userInfo.fieldDataList |
配列 |
フィールド情報リスト。 |
| data[].userInfo.fieldDataList[].fieldApiName |
文字列 |
フィールドAPI名。 |
| data[].userInfo.fieldDataList[].fieldTypeApiName |
文字列 |
フィールドAPI名。 |
| data[].userInfo.fieldDataList[].fieldValue |
文字列 |
フィールド値。 |
| data[].userInfo.fieldDataList[].foreignDataName |
文字列 |
関連オブジェクトレコード名。 |
| data[].userInfo.fieldDataList[].userEmail |
文字列 |
関連従業員メールアドレス。 |
| data[].userInfo.fieldDataList[].optionNameList |
配列 |
オプション名リスト（選択タイプフィールド）。 |
| data[].userInfo.fieldDataList[].tagValueList |
配列 |
タグフィールド詳細情報（電話またはメール）。 |
| data[].userInfo.fieldDataList[].tagValueList[].tagName |
文字列 |
タグ名。 |
| data[].userInfo.fieldDataList[].tagValueList[].tagValue |
文字列 |
タグ値。 |
| data[].userInfo.fieldDataList[].richText |
オブジェクト |
リッチテキストフィールド詳細情報（内容および添付ファイル）。 |
| data[].userInfo.fieldDataList[].richText.content |
文字列 |
リッチテキスト内容。 |
| data[].userInfo.fieldDataList[].richText.attachmentList |
配列 |
添付ファイルリスト。 |
| data[].userInfo.fieldDataList[].richText.attachmentList[].name |
文字列 |
元のファイル名。 |
| data[].userInfo.fieldDataList[].richText.attachmentList[].docAddress |
文字列 |
外部リンク。 |
| data[].userInfo.fieldDataList[].richText.attachmentList[].size |
整数型 |
サイズ。 |
| data[].userInfo.fieldDataList[].ownerResult |
オブジェクト |
所有者。 |
| data[].userInfo.fieldDataList[].ownerResult.ownerType |
整数型 |
所有者タイプ。 |
| data[].userInfo.fieldDataList[].ownerResult.ownerName |
文字列 |
所有者名。 |
| data[].userInfo.fieldDataList[].signDto |
オブジェクト |
署名情報。 |
| data[].userInfo.fieldDataList[].signDto.url |
文字列 |
署名画像URL。 |
| data[].userInfo.fieldDataList[].signDto.time |
文字列 |
署名日時。 |
| ##### リクエスト例 |
|
|
$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=10&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
"code": 200,
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 2,
"total": 2
},
"data": [
{
"id": 4,
"email": "wangxianzhi@udesk.cn",
"position": {
"id": 2
},
"realname": "テスト01",
"mobile": "15834762387",
"jobNumber": "10000001",
"agentType": 1,
"agentRole": "agent",
"roleList": [
{
"id": 2
}
],
"userGroupList": [533,544],
"authorizationSetList": [],
"userInfo": {
"dataId": 3,
"objectId": 13,
"userInfoName": "テスト",
"fieldDataList": [
{
"fieldApiName": "sysusername",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト"
},
{
"fieldApiName": "wuqi",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "なし"
}
]
}
},
{
"id": 3,
"email": "zhaofeng@Udesk.cn",
"position": {
"id": 2
},
"realname": "テスト02",
"mobile": "15845647826",
"jobNumber": "88066",
"roleList": [
{
"id": 2
}
],
"authorizationSetList": [],
"userInfo": {
"dataId": 2,
"objectId": 13,
"userInfoName": "テスト01",
"fieldDataList": [
{
"fieldApiName": "sysusername",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト02"
},
{
"fieldApiName": "tudi",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト03"
},
{
"fieldApiName": "wuqi",
"fieldTypeApiName": "field_type_single_line",
"fieldValue": "テスト04"
},
{
"fieldApiName": "lianxidianhua",
"fieldTypeApiName": "field_type_telephone",
"tagValueList": [
{
"tagName": "携帯電話",
"tagValue": "15840147826"
},
{
"tagName": "携帯電話",
"tagValue": "15840178040"
}
]
}
]
}
}
]
}