사용자 정보 업데이트

Update User

PUT https://api.talkplus.io/v1.4/api/users/:userId

사용자 정보를 업데이트 합니다. data의 경우, 최대 5개의 key-value pair를 입력할 수 있습니다. key의 최대 size는 128자 이고 최대 value size는 1024자입니다. Key, value 둘 다 문자열이어야 합니다.

Path Parameters

Name	Type	Description
userId*	string

Headers

Name	Type	Description
content-type	string	application/json
api-key*	string	App API key
app-id*	string	App ID

Request Body

Name	Type	Description
username	string
profileImageUrl	string
data	object	Key-value 형식의 채널 메타 정보

200

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  }
}

500 에러 발생 시, 다음 형식의 에러 결과가 반환됩니다.

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}

Update User / Upload Profile Image File

PUT https://api.talkplus.io/v1.4/api/users/:userId

이미지 파일 업로드 시에는 Content-Type을 multipart/form-data로 보내야 합니다. 업로드 가능한 최대 파일 사이즈는 15MB입니다. data의 경우, 최대 5개의 key-value pair를 입력할 수 있습니다. key의 최대 size는 128자 이고 최대 value size는 1024자입니다. Key, value 둘 다 문자열이어야 합니다.

Path Parameters

Name	Type	Description
userId*	string

Headers

Name	Type	Description
content-type	string	must be "multipart/form-data"
api-key*	string	App API key
app-id*	string	App ID

Request Body

Name	Type	Description
username	string
data	string	Key-value 형식의 채널 메타 정보. JSON 포맷의 문자열
file	string	파일

200

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  }
}

500 에러 발생 시, 다음 형식의 에러 결과가 반환됩니다.

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}

Change User Password

PUT https://api.talkplus.io/v1.4/api/users/:userId/password

사용자 정보를 암호를 변경합니다.

길이 제한은 없지만 비밀번호가 72자보다 길면 처음 72자만 고려됩니다.

Path Parameters

Name	Type	Description
userId*	string

Headers

Name	Type	Description
content-type	string	application/json
api-key*	string	App API key
app-id*	string	App ID

Request Body

Name	Type	Description
password*	string	새 암호. 길이 제한은 없지만 비밀번호가 72자보다 길면 처음 72자만 고려됩니다.

200

{
  "user": {
    "id": "user456",
    "username": "john",
    "profileImageUrl": "http://cnd.test.com/123.jpg",
    "disablePushNotification": false,
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "updatedAt": 1603244410844,
    "createdAt": 1603244410844
  },
  "loginToken": "sfZtlsgkf3tLLk5H245dsK"
}

500 에러 발생 시, 다음 형식의 에러 결과가 반환됩니다.

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}

Register FCM Token

POST https://api.talkplus.io/v1.4/api/users/:userId/register/fcm

FCM 토큰을 User 세션에 연동합니다.

Path Parameters

Name	Type	Description
userId*	string	사용자 id

Headers

Name	Type	Description
content-type*	string	application/json
api-key*	string	App API key
app-id*	string	App ID

Request Body

Name	Type	Description
deviceId*	string	FCM 토큰을 등록하고자 하는 사용자 장치 id
fcmToken*	string	FCM 토큰 값

200: OK

{}

500: Internal Server Error 에러 발생 시, 다음 형식의 에러 결과가 반환됩니다.

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}