전화번호 가져오기

비즈니스가 WhatsApp Business 계정에 등록한 전화번호를 WhatsApp Business Management API를 사용하여 가져옵니다.

시작하기 전에

다음과 같은 항목이 필요합니다.

  • 가져오려는 비즈니스 전화번호의 WhatsApp Business 계정 ID
  • WhatsApp Business 계정과 연결된 시스템 사용자 액세스 토큰
  • whatsapp_business_management 권한

제한 사항

  • 이 API로는 등록된 전화번호를 가져오는 것만 가능합니다. 이 API를 사용하여 전화번호를 추가하거나, 업데이트하거나, 삭제할 수 없습니다.

모든 전화번호 가져오기

WhatsApp Business 계정과 연결된 모든 전화번호의 리스트를 가져오려면 WhatsApp Business 계정 > 전화번호 엔드포인트로 GET 요청을 보내세요.

또한 전화번호는 last_onboarded_time에 따라 오름차순이나 내림차순으로 정렬할 수 있으며, 이는 사용자가 임베디드 가입에 온보딩을 완료한 시점을 기준으로 합니다. 이를 지정하지 않을 경우 기본 순서는 내림차순입니다.

요청 샘플

가독성을 높이기 위해 형식을 지정했습니다.
curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}"

요청이 성공하면 모든 비즈니스 이름, 전화번호, 전화번호 ID, 비즈니스와 관련된 품질 등급의 리스트를 포함한 JSON 개체가 반환됩니다. 결과는 임베디드 가입 완료 날짜에 따라 내림차순으로 정렬됩니다(가장 최근에 온보딩된 항목부터 표시).

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
      
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

요청 샘플

가독성을 높이기 위해 형식을 지정했습니다.
curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}]&sort=['last_onboarded_time_ascending']"

요청이 성공하면 모든 비즈니스 이름, 전화번호, 전화번호 ID, 비즈니스와 관련된 품질 등급의 리스트를 포함한 JSON 개체가 반환됩니다. 사용자가 임베디드 가입을 완료한 시점을 기준으로 오름차순으로 정렬됩니다(가장 최근에 온보딩된 항목을 가장 마지막에 표시).

{
  "data": [
   {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    },
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"     
    }   
  ]
}

전화번호 필터링하기

전화번호를 쿼리하고 account_mode를 기준으로 전화번호를 필터링할 수 있습니다. 현재 이 필터링 옵션은 베타 모드로 테스트하고 있습니다. 모든 개발자가 액세스할 수 있는 것은 아닙니다.

매개변수

이름설명

field

값:account_mode

operator

값:EQUAL

value

값:SANDBOX, LIVE

요청 샘플

curl -i -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-ID}/phone_numbers?filtering=[{"field":"account_mode","operator":"EQUAL","value":"SANDBOX"}]&access_token=access-token"

응답 샘플

{
  "data": [
    {
      "id": "1972385232742141",    
      "display_phone_number": "+1 631-555-1111",
      "verified_name": "John’s Cake Shop",
      "quality_rating": "UNKNOWN",
    }
  ],
  "paging": {
	"cursors": {
		"before": "abcdefghij",
		"after": "klmnopqr"
	}
   }
}

단일 전화번호 가져오기

단일 전화번호에 대한 정보를 가져오려면 WhatsApp Business 전화번호 엔드포인트로 GET 요청을 보내세요.

요청 구문

GET https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>

요청 샘플

curl \
'https://graph.facebook.com/v15.0/105954558954427/' \
-H 'Authorization: Bearer EAAFl...'

요청이 성공하면 비즈니스 이름, 전화번호, 전화번호 ID, 쿼리한 전화번호의 품질 등급을 포함한 JSON 개체가 반환됩니다.

{
  "code_verification_status" : "VERIFIED",
  "display_phone_number" : "15555555555",
  "id" : "105954558954427",
  "quality_rating" : "GREEN",
  "verified_name" : "Support Number"
}

표시 이름 상태 가져오기(베타)

fields=name_status를 쿼리 문자열 매개변수로 포함하면 특정 전화번호와 관련된 표시 이름의 상태를 가져올 수 있습니다. 현재 이 필드는 베타 모드이며, 모든 개발자에게 제공되는 것은 아닙니다.

요청 샘플

curl \
'https://graph.facebook.com/v15.0/105954558954427?fields=name_status' \
-H 'Authorization: Bearer EAAFl...'

응답 샘플

{
  "id" : "105954558954427",
  "name_status" : "AVAILABLE_WITHOUT_REVIEW"
}

name_status 값은 다음 중 하나일 수 있습니다.

  • APPROVED: 이름이 승인되었습니다. 지금 인증서를 다운로드할 수 있습니다.
  • AVAILABLE_WITHOUT_REVIEW: 전화번호에 대한 인증서가 제공되고, 표시 이름을 검토 없이 바로 사용할 수 있습니다.
  • DECLINED: 이름이 승인되지 않았습니다. 인증서를 다운로드할 수 없습니다.
  • EXPIRED: 인증서가 만료되었고, 더 이상 다운로드할 수 없습니다.
  • PENDING_REVIEW: 이름 요청을 검토 중입니다. 인증서를 다운로드할 수 없습니다.
  • NONE: 사용할 수 있는 인증서가 없습니다.

인증서는 7일간 유효합니다.

더 알아보기

각 필드에 사용할 수 있는 모든 가능한 값의 리스트는 전화번호 필드의 그래프 API 참고 자료를 참조하세요.