배치 상세 조회

GET

https://api.claw-ops.com/v1/accounts/:accountId/call-batches/:batchId

GET

/v1/accounts/:accountId/call-batches/:batchId

curl https://api.claw-ops.com/v1/accounts/AC1a2b3c4d/call-batches/clx1a2b3c4d5e \
     -H "Authorization: Bearer <token>"

{
  "batchId": "clx1a2b3c4d5e",
  "name": "7월 예약 확인",
  "status": "draft",
  "from": "07052358010",
  "callFlowId": "string",
  "agentId": "string",
  "url": "string",
  "maxConcurrency": 1,
  "pacingPerMinute": 1,
  "timezone": "string",
  "startAt": "2024-01-15T09:30:00Z",
  "endAt": "2024-01-15T09:30:00Z",
  "machineDetection": "Enable",
  "rounds": [
    {
      "after": 1,
      "on": [
        "string"
      ],
      "windows": [
        {
          "days": [
            1
          ],
          "start": "string",
          "end": "string"
        }
      ]
    }
  ],
  "messagePolicy": {
    "onFirstFail": {
      "body": "string"
    },
    "onFinalFail": {
      "body": "string"
    }
  },
  "warnings": [
    "07052358010 번호로 문자가 전송된 이력이 없습니다. 문자 발신번호 등록은 음성과 별개 절차라, 등록되지 않은 번호는 발송 요청은 성공해도 통신사에서 전량 거절될 수 있습니다."
  ],
  "dateCreated": "2024-01-15T09:30:00Z",
  "dateUpdated": "2024-01-15T09:30:00Z",
  "counts": {
    "dialing": 3,
    "done": 77,
    "pending": 120
  }
}

진행 상황(counts)을 함께 반환합니다. 수신자별 결과는 /tasks에서 조회합니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

batchIdstringRequired

Response

조회 성공

batchIdstringOptional

namestringOptional

statusenumOptional

running=발신 중 · paused=일시정지(진행 중 통화는 유지) · canceled=취소 · completed=완료 · expired=EndAt 경과로 종료

fromstringOptional

callFlowIdstringOptional

agentIdstringOptional

urlstringOptional

maxConcurrencyintegerOptional

pacingPerMinuteintegerOptional

timezonestringOptional

startAtdatetime or nullOptional

endAtdatetime or nullOptional

machineDetectionenum or nullOptional

자동응답기 감지 모드. 사용하지 않는 배치는 null 입니다.

Allowed values:

roundslist of objectsOptional

발신 차수. 배열 인덱스가 곧 차수이고 rounds[0] 이 1차 발신입니다. 길이 1 = 한 번 걸고 끝. 각 차수가 자기 시간창(windows)을 가집니다.

messagePolicyobject or nullOptional

끝내 통화가 안 된 분께 보낼 문자. null 이면 보내지 않습니다.

warningslist of stringsOptional

생성 응답에만 포함됩니다. 거절할 정도는 아니지만 알아야 하는 것들 — 발신번호에 문자 전송 이력이 없거나(문자 발신번호 미등록 가능성), 남은 문자 한도가 수신자 수보다 적은 경우입니다.

dateCreateddatetimeOptional

dateUpdateddatetimeOptional

countsmap from strings to integersOptional

상태별 수신자 수 (pending·dialing·done·failed·canceled·expired)

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error