3 好友管理介面#
3.1 同意好友申請#
PUT /roster/accept
POST /roster/accept
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| user_id | int64 | true | 被同意的使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.2 管理員token直接加好友#
POST /roster/admin/add_direct
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| 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 | ids |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.3 申請加好友#
POST /roster/apply
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| 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 | 備註名稱 | |
| auth_answer | string | false | 問題答案 | |
| reason | string | false | 申請描述 | |
| user_id | int64 | true | 被申請使用者 ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.4 批量添加好友#
POST /roster/apply/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)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| array[object] | true | rosterApplications | ||
| ⇥ alias | string | false | 備註名稱 | |
| ⇥ reason | string | false | 申請描述 | |
| ⇥ user_id | int64 | true | 被申請使用者 ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ fails | array[object] | 失敗信息列表 |
| ⇥⇥ reason | string | 失敗原因 |
| ⇥⇥ user_id | int64 | 使用者ID |
| ⇥ success | array[int64] | 成功的使用者ID列表 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.5 好友申請列表#
GET /roster/apply/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)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標: 從哪開始拉取 |
| limit | int32 | false | 最多拉取多少條 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，回傳結果中缺失 cursor，表示已經回傳最後一頁 |
| data | array[object] | 結果資料 |
| ⇥ expired_time | int64 | 過期時間戳(毫秒) |
| ⇥ reason | string | 申請描述 |
| ⇥ status | int32 | 狀態: 0 - 等待確認, 1 - 接受, 2 - 拒絕 |
| ⇥ user_id | int64 | 發起加好友申請的使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
| version | int64 | 版本 |
介面描述#
3.6 添加黑名單#
PUT /roster/block
POST /roster/block
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.7 黑名單列表#
GET /roster/blocked_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 | array[int64] | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.8 拒絕好友申請#
PUT /roster/decline
POST /roster/decline
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| 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)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| reason | string | false | 拒絕的原因 | |
| user_id | int64 | true | 拒絕的使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.9 刪除好友#
DELETE /roster/delete
POST /roster/delete
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.10 更新好友擴展信息#
PUT /roster/ext
POST /roster/ext
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| 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 | 備註名稱 | |
| ext | string | false | 擴展信息 | |
| mute_notification | boolean | false | 是否訊息免打擾: true - 訊息免打擾, false - 不訊息免打擾 | |
| user_id | int64 | true | 好友使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.11 用ID搜索使用者#
GET /roster/id
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ alias | string | 備註名稱 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ avatar | string | 頭像 |
| ⇥ description | string | 描述信息 |
| ⇥ ext | string | 擴展信息 |
| ⇥ mute_notification | boolean | 是否訊息免打擾: true - 訊息免打擾, false - 不訊息免打擾 |
| ⇥ nick_name | string | 暱稱或名稱 |
| ⇥ public_info | string | 公開信息，好友和陌生人可見 |
| ⇥ relation | int32 | 關係: 0 - 好友, 1 - 被刪除的好友, 2 - 陌生人, 3 - 黑名單 |
| ⇥ user_id | int64 | 好友使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.12 好友列表#
GET /roster/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)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標：從哪開始取 |
| limit | int32 | false | 最多取多少條 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，回傳結果中缺失 cursor，表示已經回傳最後一頁 |
| data | array[int64] | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
| version | int64 | 版本 |
介面描述#
3.13 好友詳情列表#
POST /roster/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的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| list | array[int64] | true | 好友ID列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ alias | string | 備註名稱 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ avatar | string | 頭像 |
| ⇥ description | string | 描述信息 |
| ⇥ ext | string | 擴展信息 |
| ⇥ mute_notification | boolean | 是否訊息免打擾: true - 訊息免打擾, false - 不訊息免打擾 |
| ⇥ nick_name | string | 暱稱或名稱 |
| ⇥ public_info | string | 公開信息，好友和陌生人可見 |
| ⇥ relation | int32 | 關係: 0 - 好友, 1 - 被刪除的好友, 2 - 陌生人, 3 - 黑名單 |
| ⇥ user_id | int64 | 好友使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.14 是否允許發訊息#
GET /roster/may_message
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| roster_id | int64 | true | 好友ID |
| user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.15 用手機號搜索使用者#
GET /roster/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 | object | 結果資料 |
| ⇥ alias | string | 備註名稱 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ avatar | string | 頭像 |
| ⇥ description | string | 描述信息 |
| ⇥ ext | string | 擴展信息 |
| ⇥ mute_notification | boolean | 是否訊息免打擾: true - 訊息免打擾, false - 不訊息免打擾 |
| ⇥ nick_name | string | 暱稱或名稱 |
| ⇥ public_info | string | 公開信息，好友和陌生人可見 |
| ⇥ relation | int32 | 關係: 0 - 好友, 1 - 被刪除的好友, 2 - 陌生人, 3 - 黑名單 |
| ⇥ user_id | int64 | 好友使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.16 用使用者名搜索使用者#
GET /roster/name
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| 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 | object | 結果資料 |
| ⇥ alias | string | 備註名稱 |
| ⇥ auth_mode | int32 | 驗證方式, 0 - 無需驗證，任何人可以加為好友, 1 - 需要同意方可加為好友, 2 - 需要回答問題正確方可加為好友, 3 - 拒絕所有加好友申請 |
| ⇥ auth_question | string | 驗證問題 |
| ⇥ avatar | string | 頭像 |
| ⇥ description | string | 描述信息 |
| ⇥ ext | string | 擴展信息 |
| ⇥ mute_notification | boolean | 是否訊息免打擾: true - 訊息免打擾, false - 不訊息免打擾 |
| ⇥ nick_name | string | 暱稱或名稱 |
| ⇥ public_info | string | 公開信息，好友和陌生人可見 |
| ⇥ relation | int32 | 關係: 0 - 好友, 1 - 被刪除的好友, 2 - 陌生人, 3 - 黑名單 |
| ⇥ user_id | int64 | 好友使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
3.17 從黑名單移除#
DELETE /roster/unblock
POST /roster/unblock
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| user_id | int64 | true | 使用者ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |