User information
To enable KakaoTalk Alim Talk messaging, you must register users' phone numbers in their Sendbird user profiles first.
Note: Existing users can be updated in bulk via the Sendbird Dashboard under Business Messaging > User insights > Import users. Refer to our guide on importing user data.
Add a phone number to an existing user
Add a phone number to an existing Sendbird user profile using the following API call.
HTTP request
Request body
Properties
| Required | Type | Description |
|---|---|---|
user_id | string | Specifies a user's unique ID. Maximum length is 80 characters. |
phone_number | string | Specifies the user’s phone number with the country code. An example would be: +82010XXXXXXXX. |
| Optional | Type | Description |
|---|---|---|
nickname | string | Specifies the user's nickname. Maximum length is 80 characters. |
profile_url | string | Specifies the URL of the user's profile image. If left empty, no profile image is set for the user. Maximum length is 2,048 characters. If the profile_url property is specified, the profile_file property is not required. |
profile_file | string | Specifies the file of the user's profile image. An acceptable image is limited to a JPG, JPEG, or PNG file of up to 5 MB. When passing a file, you should send a multipart request. If the profile_file property is specified, the profile_url property is not required. |
Update user information
Update Sendbird user profile when a user changes their phone number using the following API call.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Required
| Parameter | Type | Description |
|---|---|---|
user_id | string | Specifies the user ID to update the phone number. |
Request body
The following tables list the properties of an HTTP request that this action supports.
Required
| Property | Type | Description |
|---|---|---|
phone_number | string | Specifies the user’s phone number with the country code. An example would be: +82010XXXXXXXX. |