1 使用者操作#
1.1 設定加好友驗證方式#
PUT /user/authmode
POST /user/authmode
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | int32 | true | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.2 設定頭像#
PUT /user/avatar
POST /user/avatar
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| avatar | string | true | 頭像 url |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.3 批量設定頭像#
PUT /user/avatar/batch
POST /user/avatar/batch
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ avatar | string | true | 頭像 url | |
| ⇥ user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 失敗原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.4 修改密碼#
POST /user/change_password
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| new_password | string | true | 新密碼 | |
| old_password | string | true | 舊密碼 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.5 管理員修改密碼#
POST /user/change_password_admin
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| password | string | true | 密碼 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.6 置頂會話#
PUT /user/conversation/pin
POST /user/conversation/pin
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| conversation_id | int64 | true | 會話ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.7 取得置頂會話列表#
GET /user/conversation/pin_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ conversation_ids | array[int64] | 會話ID列表 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.8 取消置頂會話#
PUT /user/conversation/unpin
POST /user/conversation/unpin
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| conversation_id | int64 | true | 會話ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.9 刪除使用者#
DELETE /user/delete
POST /user/delete
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| password | string | false | 使用者密碼：如果是使用者TOKEN,需要設定此欄位；如果是管理員TOKEN則不需設定 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.10 設備列表#
GET /user/device/list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，回傳結果中缺失 cursor，表示已經回傳最後一頁 |
| data | array[object] | 結果資料 |
| ⇥ device_sn | int32 | 設備序號 |
| ⇥ platform | int32 | 設備平臺, 1:ios, 2:android, 3:windows, 4:mac, 5:linux, 6:web |
| ⇥ user_agent | string | 設備信息 |
| ⇥ user_id | int64 | 使用者 ID |
| message | string | 錯誤信息，如果成功，該項為null |
| version | int64 | 版本 |
介面描述#
1.11 刪除device#
DELETE /user/device/remove
POST /user/device/remove
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| device_sn | int32 | true | 設備序號 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.12 封禁使用者#
PUT /user/disable
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[int64] | true | 使用者ID列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.13 設定是否自動下載縮略圖和檔案#
PUT /user/download
POST /user/download
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否自動下載縮略圖和檔案： true - 是， false - 否 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.14 解禁使用者#
PUT /user/enable
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[int64] | true | 使用者ID列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.15 踢指定設備下線#
PUT /user/kick
POST /user/kick
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| device_sn | int32 | false | 設備序號：不設定表示踢所有設備 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.16 列出APP下所有使用者#
GET /user/list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| page_num | int32 | false | 頁數：必須大於0，預設為1 |
| page_size | int32 | false | 每頁大小：預設每頁50條 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ status | int32 | 0-正常，1-封禁 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.17 設定手機號碼#
PUT /user/mobile
POST /user/mobile
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| mobile | string | true | 手機號碼 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.18 設定暱稱#
PUT /user/nickname
POST /user/nickname
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| nick_name | string | true | 暱稱 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.19 查詢使用者線上狀態#
GET /user/online_status
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ online | boolean | 是否線上： true - 線上 ，false - 離線 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.20 設定私有擴展信息#
PUT /user/private
POST /user/private
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| string | true | 私有擴展信息 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.21 取得使用者信息#
GET /user/profile
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ avatar | string | 頭像 url |
| ⇥ description | string | 描述信息 |
| string | 郵箱 | |
| ⇥ mobile | string | 手機號碼 |
| ⇥ nick_name | string | 暱稱 |
| ⇥ private_info | string | 私有信息，僅自己可見 |
| ⇥ public_info | string | 公開信息，好友和陌生人可見 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.22 更新使用者信息#
PUT /user/profile
POST /user/profile
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| description | string | false | 描述信息 | |
| nick_name | string | false | 暱稱 | |
| private_info | string | false | 私有信息，僅自己可見 | |
| public_info | string | false | 公開信息，好友和陌生人可見 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.23 批量更新使用者信息#
PUT /user/profile/batch
POST /user/profile/batch
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ description | string | false | 描述信息 | |
| ⇥ nick_name | string | false | 暱稱 | |
| ⇥ private_info | string | false | 私有信息，僅自己可見 | |
| ⇥ public_info | string | false | 公開信息，好友和陌生人可見 | |
| ⇥ user_id | int64 | false | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 失敗原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.24 設定公開擴展信息#
PUT /user/public
POST /user/public
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| string | true | 公開擴展信息 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.25 設定是否關閉推播#
PUT /user/push
POST /user/push
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否關閉推播： true - 關閉推播， false - 不關閉推播 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.26 綁定別名#
POST /user/push/alias
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| alias | string | true | 別名 | |
| push_token | string | false | 推播token |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.27 設定badge#
POST /user/push/badge
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| badge | int32 | true | badge |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.28 設定是否關閉推播詳情#
PUT /user/push/detail
POST /user/push/detail
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否關閉推播詳情: true - 關閉推播詳情, false - 不關閉推播詳情 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.29 設定推播免打擾時間#
PUT /user/push/limit
POST /user/push/limit
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| no_push_end_hour | int32 | true | 推播免打擾結束的小時（0-23） |
| no_push_start_hour | int32 | true | 推播免打擾開始的小時（0-23） |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.30 設定推播暱稱#
PUT /user/push/nickname
POST /user/push/nickname
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | string | true | 推播暱稱 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.31 取得標籤#
GET /user/push/tag
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[string] | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.32 綁定標籤#
POST /user/push/tag
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| tags | array[string] | true | 標籤列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.33 解綁標籤#
DELETE /user/push/tag
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| tags | array[string] | true | 標籤列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.34 刪除所有標籤#
DELETE /user/push/tag/all
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.35 批量註冊使用者#
POST /user/register/batch
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[object] | false | ||
| ⇥ password | string | true | 密碼 | |
| ⇥ username | string | true | 使用者名 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 失敗原因 |
| ⇥ success | boolean | 是否成功 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.36 註冊推播使用者#
POST /user/register/push
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| alias | string | false | 別名 | |
| device_guid | string | false | 設備ID | |
| password | string | true | 密碼 | |
| push_token | string | false | 推播token | |
| sign | string | false | 簽名 | |
| username | string | true | 使用者名 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ auth_answer | string | 驗證問題答案 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ auto_download | boolean | 是否自動下載: true - 自動下載, false - 不自動下載 |
| ⇥ group_confirm | boolean | 邀請入群時是否需要使用者確認: true - 需要使用者同意才可加入， false - 自動同意邀請 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否關閉推播訊息: true - 關閉推播訊息, false - 不關閉推播訊息 |
| ⇥ no_push_detail | boolean | 是否推播詳情: true - 推播詳情, false - 不推播詳情 |
| ⇥ no_push_end_hour | int32 | 推播免打擾結束時間（小時 0-23） |
| ⇥ no_push_start_hour | int32 | 推播免打擾開始時間（小時 0-23） |
| ⇥ no_sounds | boolean | 收到訊息時是否靜音: true - 靜音, false - 不靜音 |
| ⇥ push_nick_name | string | 推播暱稱 |
| ⇥ push_token | string | 推播token |
| ⇥ silence_end_time | int32 | 推播不提醒結束時間（小時 0-23） |
| ⇥ silence_start_time | int32 | 推播不提醒開始時間（小時 0-23） |
| ⇥ stranger_chat | int32 | 陌生人聊天處理方式： 0 - 未設定， 1 - 允許， 2 - 拒絕 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ vibratory | boolean | 收到訊息時否振動: true - 振動， false - 不振動 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.37 註冊使用者#
POST /user/register/v2
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| password | string | true | 密碼 | |
| username | string | true | 使用者名 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ auth_answer | string | 驗證問題答案 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ auto_download | boolean | 是否自動下載: true - 自動下載, false - 不自動下載 |
| ⇥ group_confirm | boolean | 邀請入群時是否需要使用者確認: true - 需要使用者同意才可加入， false - 自動同意邀請 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否關閉推播訊息: true - 關閉推播訊息, false - 不關閉推播訊息 |
| ⇥ no_push_detail | boolean | 是否推播詳情: true - 推播詳情, false - 不推播詳情 |
| ⇥ no_push_end_hour | int32 | 推播免打擾結束時間（小時 0-23） |
| ⇥ no_push_start_hour | int32 | 推播免打擾開始時間（小時 0-23） |
| ⇥ no_sounds | boolean | 收到訊息時是否靜音: true - 靜音, false - 不靜音 |
| ⇥ push_nick_name | string | 推播暱稱 |
| ⇥ push_token | string | 推播token |
| ⇥ silence_end_time | int32 | 推播不提醒結束時間（小時 0-23） |
| ⇥ silence_start_time | int32 | 推播不提醒開始時間（小時 0-23） |
| ⇥ stranger_chat | int32 | 陌生人聊天處理方式： 0 - 未設定， 1 - 允許， 2 - 拒絕 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ vibratory | boolean | 收到訊息時否振動: true - 振動， false - 不振動 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.38 取得使用者設定#
GET /user/settings
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ auth_answer | string | 驗證問題答案 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ auto_download | boolean | 是否自動下載: true - 自動下載, false - 不自動下載 |
| ⇥ group_confirm | boolean | 邀請入群時是否需要使用者確認: true - 需要使用者同意才可加入， false - 自動同意邀請 |
| ⇥ id | int64 | |
| ⇥ no_push | boolean | 是否關閉推播訊息: true - 關閉推播訊息, false - 不關閉推播訊息 |
| ⇥ no_push_detail | boolean | 是否推播詳情: true - 推播詳情, false - 不推播詳情 |
| ⇥ no_push_end_hour | int32 | 推播免打擾結束時間（小時 0-23） |
| ⇥ no_push_start_hour | int32 | 推播免打擾開始時間（小時 0-23） |
| ⇥ no_sounds | boolean | 收到訊息時是否靜音: true - 靜音, false - 不靜音 |
| ⇥ push_nick_name | string | 推播暱稱 |
| ⇥ push_token | string | 推播token |
| ⇥ silence_end_time | int32 | 推播不提醒結束時間（小時 0-23） |
| ⇥ silence_start_time | int32 | 推播不提醒開始時間（小時 0-23） |
| ⇥ stranger_chat | int32 | 陌生人聊天處理方式： 0 - 未設定， 1 - 允許， 2 - 拒絕 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ vibratory | boolean | 收到訊息時否振動: true - 振動， false - 不振動 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.39 修改使用者設定#
PUT /user/settings
POST /user/settings
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| auth_answer | string | false | 驗證問題答案 | |
| auth_mode | int32 | false | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 | |
| auth_question | string | false | 驗證問題 | |
| auto_download | boolean | false | 是否自動下載: true - 自動下載, false - 不自動下載 | |
| group_confirm | boolean | false | 邀請入群時是否需要使用者確認: true - 需要使用者同意才可加入， false - 自動同意邀請 | |
| id | int64 | false | ||
| no_push | boolean | false | 是否關閉推播訊息: true - 關閉推播訊息, false - 不關閉推播訊息 | |
| no_push_detail | boolean | false | 是否推播詳情: true - 推播詳情, false - 不推播詳情 | |
| no_push_end_hour | int32 | false | 推播免打擾結束時間（小時 0-23） | |
| no_push_start_hour | int32 | false | 推播免打擾開始時間（小時 0-23） | |
| no_sounds | boolean | false | 收到訊息時是否靜音: true - 靜音, false - 不靜音 | |
| push_nick_name | string | false | 推播暱稱 | |
| push_token | string | false | 推播token | |
| silence_end_time | int32 | false | 推播不提醒結束時間（小時 0-23） | |
| silence_start_time | int32 | false | 推播不提醒開始時間（小時 0-23） | |
| stranger_chat | int32 | false | 陌生人聊天處理方式： 0 - 未設定， 1 - 允許， 2 - 拒絕 | |
| user_id | int64 | true | 使用者ID | |
| vibratory | boolean | false | 收到訊息時否振動: true - 振動， false - 不振動 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.40 設定新訊息是否關閉聲音提醒#
PUT /user/sounds
POST /user/sounds
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否關閉聲音提醒: true - 關閉聲音提醒, false - 不關閉聲音提醒 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.41 陌生人聊天處理方式#
PUT /user/stranger_chat
POST /user/stranger_chat
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | int32 | true | 陌生人聊天處理方式： 0 - 未設定， 1 - 允許， 2 -拒絕 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.42 綁定token#
PUT /user/token/bind
POST /user/token/bind
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| device_sn | int32 | true | 設備序號 | |
| device_token | string | true | device token | |
| notifier_name | string | true | 證書名稱 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.43 解綁token#
DELETE /user/token/unbind
POST /user/token/unbind
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| deviceSn | int32 | true | 設備序號 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.44 修改使用者名#
PUT /user/username
POST /user/username
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| username | string | true | 使用者名 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
1.45 設定新訊息是否振動#
PUT /user/vibratory
POST /user/vibratory
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| value | boolean | true | 是否振動： true-振動, false-不振動 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |