Skip to content

유효하지 않은 전화번호 조회

get

/sms/invalid_phone_numbers

이 엔드포인트를 사용하여 특정 기간 내에 ‘유효하지 않음’으로 표시된 전화번호 목록을 가져올 수 있습니다. 자세한 내용은 유효하지 않은 전화번호 처리 설명서를 참조하세요.

See me in Postman

필수 조건

이 엔드포인트를 사용하려면 sms.invalid_phone_numbers 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 API 사용량 제한 설명서에 명시된 대로 기본 Braze 사용량 제한인 시간당 250,000건의 요청이 적용됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
start_date 선택 사항
(참고 참조)		 YYYY-MM-DD 형식의 문자열 유효하지 않은 전화번호를 검색할 범위의 시작 날짜로, end_date보다 이전이어야 합니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
end_date 선택 사항
(참고 참조)		 YYYY-MM-DD 형식의 문자열 유효하지 않은 전화번호를 검색할 범위의 종료 날짜입니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
limit 선택 사항 정수 반환되는 결과 수를 제한하는 선택적 필드입니다. 기본값은 100이며, 최대값은 500입니다.
offset 선택 사항 정수 검색을 시작할 목록의 시작점입니다(선택 사항).
phone_numbers 선택 사항
(참고 참조)		 e.164 형식의 문자열 배열 제공된 경우, 해당 전화번호가 유효하지 않은 것으로 확인되면 반환합니다.
reason 선택 사항
(참고 참조)		 문자열 사용 가능한 값은 “provider_error”(공급자 오류로 인해 해당 전화기에서 SMS를 수신할 수 없음) 또는 “deactivated”(전화번호가 비활성화됨)입니다. 생략하면 모든 사유가 반환됩니다.

날짜 범위에 유효하지 않은 전화번호가 limit 개수보다 많은 경우, 매번 offset을 늘려가며 limit보다 적거나 결과가 0이 될 때까지 여러 번 API를 호출해야 합니다.

요청 예시

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/sms/invalid_phone_numbers?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&phone_numbers[]=12345678901' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

응답

항목은 내림차순으로 나열됩니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "sms": [
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "provider_error"
    },
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "deactivated"
    },
    {
      "phone": (string) phone number in e.164 format,
      "invalid_detected_at": (string) the time the invalid number was detected in ISO 8601
      "reason" : "provider_error"
    }
  ],
  "message": "success"
}
New Stuff!