コンテンツにスキップ
nocall.ainocall ドキュメント

エンドユーザーを作成して即時架電する

POST
/api/v1/end-users/add-and-call
curl --request POST \
  --url https://api.nocall.ai/api/v1/end-users/add-and-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "phoneNumber": "example", "familyName": "example", "givenName": "example", "familyNameKana": "example", "givenNameKana": "example", "companyName": "example", "email": "example", "userGroupId": "example", "agentId": "example", "attributions": [ { "label": "example", "value": "example" } ], "autoRedialConfig": { "enabled": true, "targetCallStatuses": [ "completed" ], "targetDestinationTypes": [ "human" ], "targetAnalysisConditions": [ { "type": "boolean", "analysisId": "example", "value": true, "matchType": "and" } ], "analysisConditionMatchType": "and", "maxRetries": 1 } }'

エンドユーザーを登録し、指定したエージェントによる架電を予約します。

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
phoneNumber
required

+81などの国番号から始まる電話番号

string
>= 1 characters <= 20 characters
familyName

非推奨。attributionsを使用してください

string
givenName

非推奨。attributionsを使用してください

string
familyNameKana

非推奨。attributionsを使用してください

string
givenNameKana

非推奨。attributionsを使用してください

string
companyName

非推奨。attributionsを使用してください

string
email

非推奨。attributionsを使用してください

string
userGroupId

登録先のコンタクトグループID

string
>= 1 characters
agentId

架電に使用するエージェントID

string
>= 1 characters
attributions

エンドユーザー属性。labelは重複不可

Array<object>
object
label
required

属性名

string
>= 1 characters
value
required

属性値

string
autoRedialConfig
object
enabled
required
boolean
targetCallStatuses
required
Array<string>
Allowed values: completed no_answer unreachable failed
targetDestinationTypes
Array<string>
Allowed values: human voicemail
targetAnalysisConditions
Array
Any of:
object
type
required
string
Allowed values: boolean
analysisId
required
string
value
required
boolean
matchType
string
Allowed values: and or
analysisConditionMatchType
string
Allowed values: and or
maxRetries
required
integer
>= 1

Responses

Section titled “Responses”

201

Section titled “201”

架電を受け付けました

Media typeapplication/json

即時架電の受付結果

object
message
required

受付結果のメッセージ

string
endUserId
required

作成されたエンドユーザーID

string
callTaskId
required

作成された架電タスクID

string
Example
{
  "message": "エンドユーザーが作成され、架電がスケジュールされました",
  "endUserId": "edu_XXX",
  "callTaskId": "ctt_XXX"
}

400

Section titled “400”

リクエストが不正です

Media typeapplication/json
Any of:
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Example
{
  "success": false
}

401

Section titled “401”

APIキーが未指定または無効です

Media typeapplication/json
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}

403

Section titled “403”

IP制限などによりアクセスできません

Media typeapplication/json
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}

404

Section titled “404”

APIキーに紐づくプロジェクト、コンタクトグループ、またはエージェントが見つかりません

Media typeapplication/json
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}

429

Section titled “429”

レート制限を超えました

Media typeapplication/json
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}

500

Section titled “500”

サーバー内部でエラーが発生しました

Media typeapplication/json
object
code

機械判定用のエラーコード

string
error
required

エラー内容

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}