유효하지 않은 전화번호 조회
get
/sms/invalid_phone_numbers
이 엔드포인트를 사용하여 특정 기간 내에 ‘유효하지 않음’으로 표시된 전화번호 목록을 가져올 수 있습니다. 자세한 내용은 유효하지 않은 전화번호 처리 문서를 참조하세요.
필수 구성 요소
이 엔드포인트를 사용하려면 sms.invalid_phone_numbers
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
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”(휴대폰 번호가 비활성화됨)입니다. 생략하면 모든 사유가 반환됩니다. |
note:
start_date
와 end_date
또는 phone_numbers
중 하나를 제공해야 합니다. start_date
, end_date
, phone_numbers
세 가지를 모두 제공하면 주어진 전화번호를 우선적으로 처리하고 날짜 범위는 무시합니다.
날짜 범위에 유효하지 않은 전화번호가 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
21
22
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"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!