차단 번호 생성 - vox.ai Docs

POST

blocked-numbers

curl --request POST \
  --url https://client-api.tryvox.co/v3/blocked-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "01099991234",
  "scope": "global",
  "direction": "both",
  "memo": "응대팀 요청 차단",
  "is_active": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "<string>",
  "is_active": true,
  "created_at": 123,
  "updated_at": 123,
  "specific_organization_telephone_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "memo": "<string>"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed.",
    "details": {
      "field": "name",
      "reason": "must not be blank"
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "details": {}
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Permission denied.",
    "details": {}
  }
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found.",
    "details": {
      "resource": "agent"
    }
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested operation conflicts with current state.",
    "details": {
      "current_status": "draft"
    }
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests.",
    "details": {
      "limit": 5,
      "window_seconds": 1
    }
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error.",
    "details": {}
  }
}

{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable.",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Body

application/json

생성할 차단 번호 규칙입니다.

number

string

required

차단할 전화번호입니다. 하이픈 없는 숫자 문자열로 정규화되어 저장·반환됩니다.

Required string length: 1 - 32

scope

enum<string>

required

차단 규칙의 적용 범위입니다.

Available options:

global,

specific

specific_organization_telephone_ids

string<uuid>[]

scope가 'specific'일 때 규칙이 적용되는 보유 전화번호 ID 목록입니다. 'global'이면 빈 배열입니다.

direction

enum<string>

default:both

차단할 통화 방향입니다. inbound는 수신, outbound는 발신, both는 양방향입니다.

Available options:

inbound,

outbound,

both

memo

string | null

규칙에 대한 메모입니다. 최대 500자.

Maximum string length: 500

is_active

boolean

default:true

현재 차단 판정에 적용되는지 여부입니다. 비활성이면 목록에는 남지만 판정에서 제외됩니다.

Response

성공 응답

string<uuid>

required

차단 규칙 ID입니다.

organization_id

string<uuid>

required

차단 번호를 등록한 조직 ID입니다.

number

string

required

차단할 전화번호입니다. 하이픈 없는 숫자 문자열로 정규화되어 저장·반환됩니다.

scope

enum<string>

required

차단 규칙의 적용 범위입니다.

Available options:

global,

specific

direction

enum<string>

required

차단할 통화 방향입니다. inbound는 수신, outbound는 발신, both는 양방향입니다.

Available options:

inbound,

outbound,

both

is_active

boolean

required

현재 차단 판정에 적용되는지 여부입니다. 비활성이면 목록에는 남지만 판정에서 제외됩니다.

created_at

integer

required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

updated_at

integer

required

리소스 마지막 수정 시각입니다. unix milliseconds 형식입니다.

specific_organization_telephone_ids

string<uuid>[]

scope가 'specific'일 때 규칙이 적용되는 보유 전화번호 ID 목록입니다. 'global'이면 빈 배열입니다.

memo

string | null

규칙에 대한 메모입니다. 최대 500자.

차단 번호 일괄 생성한 요청으로 차단 번호 규칙을 최대 500건까지 생성합니다. 각 번호는 독립적으로 처리되며, 실패 항목은 성공 항목을 되돌리지 않고 `results`에 보고됩니다. 중복 규칙은 `skipped`로 반환되며, 기존 규칙 교체는 지원하지 않습니다.

curl --request POST \
  --url https://client-api.tryvox.co/v3/blocked-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "01099991234",
  "scope": "global",
  "direction": "both",
  "memo": "응대팀 요청 차단",
  "is_active": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": "<string>",
  "is_active": true,
  "created_at": 123,
  "updated_at": 123,
  "specific_organization_telephone_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "memo": "<string>"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed.",
    "details": {
      "field": "name",
      "reason": "must not be blank"
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "details": {}
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Permission denied.",
    "details": {}
  }
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found.",
    "details": {
      "resource": "agent"
    }
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested operation conflicts with current state.",
    "details": {
      "current_status": "draft"
    }
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests.",
    "details": {
      "limit": 5,
      "window_seconds": 1
    }
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error.",
    "details": {}
  }
}

{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable.",
    "details": {}
  }
}