UA 친구 목록

유저 애퀴지션 CPI를 달성한 초대 유저와 초대받은 유저에 대한 정보(VID, PlayerID)를 제공합니다. 해당 정보를 활용하여 게임 내에서 UA 친구 목록을 구성할 수 있습니다.

• Request URL
  

  상용 URL	https://promotion.qpyou.cn/ua/user/invitee
  Sandbox URL	https://sandbox-promotion.qpyou.cn/ua/user/invitee
  HTTP Method	POST
  Content-Type	text/html
  Data Format	JSON

• Header
  

  필드명	설명	타입	필수여부
  Authorization	Bearer Authorization으로 certificationKey 유효 판단	String	N

• Request
  

  필드명	설명	타입	필수여부
  game_index	앱센터에 등록된 게임 인덱스	Integer	Y
  begin_id	UA – CPI 친구 목록을 읽을 시작 위치 (ID 값이며 처음 요청할 때는 0)	Integer	Y
  data_limit	한 번에 읽어올 친구 목록 개수. 입력하지 않았을 때 기본 값은 1000개	Integer	N
  sender_vid	초대자 VID, PlayerID	String	N

• Response
  

  필드명	설명	타입	필수여부
  result_code	응답 코드 0: 검증 성공 그 외: 실패	Integer	Y
  result_message	응답 메시지	String	Y
  request	API를 요청할 때 수신했던 데이터 (request 데이터 그대로 다시 제공)	Array	Y
  ㄴ game_index	앱센터에 등록된 게임 인덱스	Integer	Y
  ㄴ begin_id	UA – CPI 친구 목록을 읽을 시작 위치 (ID 값이며 처음 요청할 때는 0)	Integer	Y
  ㄴ data_limit	한 번에 읽어올 친구 목록 개수. 입력하지 않았을 때 기본 값은 1000개	Integer	N
  ㄴ sender_vid	초대자 VID, PlayerID	String	N
  result	친구 목록. 없을 경우 null 처리 가능	Array	N
  ㄴ companion_id	HIVE 내부 관리용 ID	String	Y
  ㄴ sender_vid	초대한 유저의 VID, PlayerID	String	Y
  ㄴ receiver_vid	초대받은 유저의 VID, PlayerID	String	Y
  ㄴ dateadd	친구맺은 시간	String (DateTime)	Y
  ㄴ id	현재 데이터의 고유 ID (다음 데이터 요청시 필요)	String	Y
  result_count	결과(result)의 수	Integer	Y
  last_id	제공된 친구 목록 중 마지막 고유 ID (다음 데이터를 요청할 때 사용)	Integer	Y

• Result code
  

  코드	메시지	설명
  0	Success	데이터 전달 성공
  201	Invalid parameter	전송된 파라미터가 없거나 잘못되었을 때 (필수 값 누락). POST로 전송되지 았을 때

• 호출 예제
  
  curl -L -v -d '{"game_index": 539, "begin_id": 0, "data_limit": 3, "sender_vid": 21001}' -H "Content-Type: application/json" https://sandbox-promotion.qpyou.cn/ua/user/invitee

  1 2 3 4

  curl -L -v -d '{"game_index": 539, "begin_id": 0, "data_limit": 3, "sender_vid": 21001}' -H "Content-Type: application/json" https://sandbox-promotion.qpyou.cn/ua/user/invitee

• 요청 예제
  
  > POST /ua/user/invitee HTTP/1.1 > User-Agent: curl/7.29.0 > Host: sandbox-promotion.qpyou.cn > Accept: / > Content-Type: application/json > Content-Length: 72

  1 2 3 4 5 6

  > POST /ua/user/invitee HTTP/1.1 > User-Agent: curl/7.29.0 > Host: sandbox-promotion.qpyou.cn > Accept: / > Content-Type: application/json > Content-Length: 72

• 응답 예제
  
  < HTTP/1.1 200 OK < Server: nginx < Date: Tue, 15 Mar 2022 03:26:19 GMT < Content-Type: application/json {"result_code":0,"result_message":"success","request":{"game_index":539,"begin_id":0,"data_limit":3,"sender_vid":21001},"result":[],"result_count":0,"last_id":0}

  1 2 3 4 5

  < HTTP/1.1 200 OK < Server: nginx < Date: Tue, 15 Mar 2022 03:26:19 GMT < Content-Type: application/json {"result_code":0,"result_message":"success","request":{"game_index":539,"begin_id":0,"data_limit":3,"sender_vid":21001},"result":[],"result_count":0,"last_id":0}