Method: users.batchGet

사용자 목록의 RCS 지원 전화번호를 가져옵니다.

반환된 페이로드에는 지정된 사용자를 위해 비즈니스용 RCS 플랫폼에서 연결할 수 있는 RCS 지원 전화번호 목록이 포함됩니다. 에이전트가 실행되는 이동통신사에서 RCS를 지원하는 전화번호만 반환됩니다.

반환된 페이로드에는 에이전트의 실행 상태와 관계없이 전화번호 목록의 잠재적 도달범위를 추정하는 데 사용할 수 있는 값도 포함됩니다.

분당 최대 쿼리 수 (QPM)는 600개입니다.

중요: users.batchGet 메서드를 사용하려면 리전 엔드포인트를 사용해야 합니다. 요청에는 단일 지리적 리전의 전화번호가 포함되어야 합니다. 단일 요청에서 여러 리전의 전화번호를 보내거나 잘못된 리전 엔드포인트로 보내면 400 Bad Request 오류가 발생합니다.

리전 엔드포인트:

HTTP 요청

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "users": [
    string
  ],
  "agentId": string
}
필드
users[]

string

E.164 형식의 사용자 전화번호 목록입니다.

단일 요청의 모든 전화번호는 동일한 지리적 리전에 속해야 합니다. 여러 리전의 전화번호가 포함된 요청 또는 잘못된 리전 엔드포인트로 전송된 요청은 400 Bad Request 오류와 함께 실패합니다.
agentId

string

필수 항목입니다. 에이전트의 고유 식별자입니다.

응답 본문

비즈니스용 RCS의 사용자 연결 가능성 데이터가 포함된 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
필드
reachableUsers[]

string

비즈니스용 RCS에서 연결할 수 있는 사용자 전화번호 목록입니다. 에이전트가 실행되는 이동통신사의 사용자만 포함됩니다.
totalRandomSampleUserCount

integer

reachableUsers에서 무작위로 선택된 전화번호 수입니다. 일반적으로 이 값은 요청된 총 전화번호의 약 75% 입니다. 요청된 전화번호 수가 500개 미만이면 이 값은 0입니다.
reachableRandomSampleUserCount

integer

에이전트의 실행 상태와 관계없이 모든 이동통신사에서 RCS로 연결할 수 있는 무작위로 선택된 목록의 전화번호 수입니다. 이 값과 totalRandomSampleUserCount 간의 비율은 사용자 목록의 잠재적 도달범위를 대략적으로 나타낼 수 있습니다.
reachableUsersMap

map (key: string, value: object (ReachableUsers))

출력 전용입니다. 이동통신사 ID와 해당 이동통신사에서 연결할 수 있는 사용자 목록을 매핑합니다. 이 필드는 미국 전화번호에만 채워집니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/rcsbusinessmessaging

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

ReachableUsers

특정 이동통신사에서 연결할 수 있는 사용자 목록입니다.

JSON 표현 
{
  "reachableUsers": [
    string
  ]
}
필드
reachableUsers[]

string

특정 이동통신사에서 연결할 수 있는 사용자 목록입니다. 이 필드는 미국 전화번호에만 채워집니다.