Platform API

Apply to add a friend

Use Apply to add a friend to submit a friend request from one user to another.

HTTP request

POST {API_ADDRESS}/friend/add_friend

Request example

curl --request POST "${API_ADDRESS}/friend/add_friend" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "fromUserID": "user_001",
  "toUserID": "user_002",
  "reqMsg": "Example value",
  "ex": ""
}'

Keep administrator tokens on trusted backend services only. Client applications should use user tokens issued by your backend.

Request body

{
  "fromUserID": "user_001",
  "toUserID": "user_002",
  "reqMsg": "Example value",
  "ex": ""
}

Parameter	Required	Type	Description
fromUserID	Yes	string	Sender user ID.
toUserID	Yes	string	User who receives the friend request.
reqMsg	No	string	Optional request message shown to the recipient.
ex	No	string	Business extension field.

Response

OpenIM usually returns 200 OK when the request reaches the service. Use errCode in the JSON response to determine business success; errCode === 0 means the operation succeeded.

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

Response fields

Field	Type	Description
errCode	int	Business error code. `0` means success.
errMsg	string	Short error message.
errDlt	string	Detailed error information for troubleshooting.
data	object	Endpoint-specific response data.
data	object	Endpoint-specific response data.

Error response

When a request fails, OpenIM returns the same error envelope. See Error codes for the full handling model.

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Scenario	Possible cause	Recommended action
Authentication failed	`token` is missing, expired, or not an administrator token.	Issue a new administrator token and keep it on the backend.
Traceability is weak	`operationID` is missing or reused across many requests.	Generate a unique `operationID` for every request and log it with the response.
Validation failed	The request body has an invalid type, missing field, or unsupported enum value.	Compare the payload with the request table and retry after correcting the fields.

Permissions and limits

Call this endpoint from a trusted backend service.
Log operationID, the endpoint path, and the response error fields for troubleshooting.
Treat write operations as state-changing. If a retry follows an uncertain failure, check the resource state first.

Was this page helpful?