{
  "name": "npp",
  "display_name": "号码保护",
  "description": "",
  "domain": "other",
  "api_version": "2019-08-23",
  "endpoint": "npp.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateCallBack",
      "description": "回拨呼叫请求",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "Src",
          "type": "string",
          "required": true,
          "description": "主叫号码(必须为 11 位手机号，号码前加 0086，如 008613631686024)"
        },
        {
          "name": "Dst",
          "type": "string",
          "required": true,
          "description": "被叫号码(必须为 11 位手机或固话号码,号码前加 0086，如008613631686024，固话如：0086075586013388)"
        },
        {
          "name": "SrcDisplayNum",
          "type": "string",
          "required": false,
          "description": "主叫显示系统分配的固话号码，如不填显示随机分配号码"
        },
        {
          "name": "DstDisplayNum",
          "type": "string",
          "required": false,
          "description": "被叫显示系统分配的固话号码，如不填显示随机分配号码"
        },
        {
          "name": "Record",
          "type": "string",
          "required": false,
          "description": "是否录音，0 表示不录音，1 表示录音。默认为不录音"
        },
        {
          "name": "MaxAllowTime",
          "type": "string",
          "required": false,
          "description": "允许最大通话时间，不填默认为 30 分钟（单位：分钟）"
        },
        {
          "name": "StatusFlag",
          "type": "string",
          "required": false,
          "description": "主叫发起呼叫状态：1 被叫发起呼叫状态：256 主叫响铃状态：2 被叫响铃状态：512 主叫接听状态：4 被叫接听状态：1024 主叫拒绝接听状态：8 被叫拒绝接听状态：2048 主叫正常挂机状态：16 被叫正常挂机状态：4096 主叫呼叫异常：32 被叫呼叫异常：8192 例如：当值为 0：表示所有状态不需要推送；当值为 4：表示只要推送主叫接听状态；当值为 16191：表示所有状态都需要推送(上面..."
        },
        {
          "name": "StatusUrl",
          "type": "string",
          "required": false,
          "description": "状态回调通知地址，正式环境可以配置默认推送地址"
        },
        {
          "name": "HangupUrl",
          "type": "string",
          "required": false,
          "description": "话单回调通知地址，正式环境可以配置默认推送地址"
        },
        {
          "name": "RecordUrl",
          "type": "string",
          "required": false,
          "description": "录单 URL 回调通知地址，正式环境可以配置默认推送地址"
        },
        {
          "name": "BizId",
          "type": "string",
          "required": false,
          "description": "业务应用 key，业务用该 key 可以区分内部业务或客户产品等，该 key 需保证在该 appId 下全局唯一，最大长度不超过 64 个字节，bizId 只能包含数字、字母。"
        },
        {
          "name": "LastCallId",
          "type": "string",
          "required": false,
          "description": "最后一次呼叫 callId，带上该字段以后，平台会参考该 callId 分配线路，优先不分配该 callId 通话线路（注：谨慎使用，这个会影响线路调度）"
        },
        {
          "name": "PreCallerHandle",
          "type": "object",
          "required": false,
          "description": "结构体，主叫呼叫预处理操作，根据不同操作确认是否呼通被叫。如需使用，本结构体需要与 keyList 结构体配合使用，此时这两个参数都为必填项",
          "children": [
            {
              "name": "ReadPrompt",
              "type": "string",
              "required": true,
              "description": "呼叫主叫以后，给主叫用户的语音提示，播放该提示时用户所有按键无效"
            },
            {
              "name": "InterruptPrompt",
              "type": "string",
              "required": true,
              "description": "可中断提示，播放该提示时，用户可以按键"
            },
            {
              "name": "KeyList",
              "type": "array",
              "required": true,
              "description": "对应按键操作,如果没有结构体里定义按键操作用户按键以后都从 interruptPrompt 重新播放",
              "item_type": "object",
              "children": [
                {
                  "name": "Key",
                  "type": "string",
                  "required": true,
                  "description": "用户按键（0-9、*、#、A-D)"
                },
                {
                  "name": "Operate",
                  "type": "string",
                  "required": true,
                  "description": "1: 呼通被叫 2：interruptPrompt 重播提示 3：拆线"
                }
              ]
            },
            {
              "name": "RepeatTimes",
              "type": "string",
              "required": true,
              "description": "最多重复播放次数，超过该次数拆线"
            },
            {
              "name": "KeyPressUrl",
              "type": "string",
              "required": true,
              "description": "用户按键回调通知地址，如果为空不回调"
            },
            {
              "name": "PromptGender",
              "type": "string",
              "required": true,
              "description": "提示音男声女声：1女声，2男声。默认女声"
            }
          ]
        },
        {
          "name": "OrderId",
          "type": "string",
          "required": false,
          "description": "订单 ID，最大长度不超过64个字节，对于一些有订单状态 App 相关应用使用（如达人帮接入 App 应用)，该字段只在帐单中带上，其它回调不附带该字段"
        }
      ],
      "required": [
        "BizAppId",
        "Src",
        "Dst"
      ]
    },
    {
      "name": "DelVirtualNum",
      "description": "直拨解绑中间号",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "BindId",
          "type": "string",
          "required": true,
          "description": "双方号码 + 中间号绑定 ID，该 ID 全局唯一"
        },
        {
          "name": "BizId",
          "type": "string",
          "required": false,
          "description": "应用二级业务 ID，bizId 需保证在该 appId 下全局唯一，最大长度不超过 16 个字节。"
        }
      ],
      "required": [
        "BizAppId",
        "BindId"
      ]
    },
    {
      "name": "DeleteCallBack",
      "description": "回拨呼叫取消",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "CallId",
          "type": "string",
          "required": true,
          "description": "回拨请求响应中返回的 callId"
        },
        {
          "name": "CancelFlag",
          "type": "string",
          "required": false,
          "description": "0：不管通话状态直接拆线（默认) 1：主叫响铃以后状态不拆线 2：主叫接听以后状态不拆线 3：被叫响铃以后状态不拆线 4：被叫接听以后状态不拆线"
        }
      ],
      "required": [
        "BizAppId",
        "CallId"
      ]
    },
    {
      "name": "DescribeCallBackCdr",
      "description": "回拨话单获取接口",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "CallId",
          "type": "string",
          "required": false,
          "description": "回拨请求响应中返回的 callId，按 callId 查询该话单详细信息"
        },
        {
          "name": "Src",
          "type": "string",
          "required": false,
          "description": "查询主叫用户产生的呼叫话单，如填空表示拉取这个时间段所有话单"
        },
        {
          "name": "StartTimeStamp",
          "type": "string",
          "required": false,
          "description": "话单开始时间戳"
        },
        {
          "name": "EndTimeStamp",
          "type": "string",
          "required": false,
          "description": "话单结束时间戳"
        }
      ],
      "required": [
        "BizAppId"
      ]
    },
    {
      "name": "DescribeCallBackStatus",
      "description": "回拨通话状态获取",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "CallId",
          "type": "string",
          "required": true,
          "description": "回拨请求响应中返回的 callId"
        },
        {
          "name": "Src",
          "type": "string",
          "required": false,
          "description": "主叫号码"
        },
        {
          "name": "Dst",
          "type": "string",
          "required": false,
          "description": "被叫号码"
        },
        {
          "name": "CallStatus",
          "type": "string",
          "required": false,
          "description": "通话最后状态：0：未知状态 1：主叫响铃中 2：主叫接听 3：被叫响铃中 4：正常通话中 5：通话结束"
        }
      ],
      "required": [
        "BizAppId",
        "CallId"
      ]
    },
    {
      "name": "DescribeCallerDisplayList",
      "description": "回拨拉取主叫显号号码集合",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        }
      ],
      "required": [
        "BizAppId"
      ]
    },
    {
      "name": "Get400Cdr",
      "description": "直拨话单获取接口",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "CallId",
          "type": "string",
          "required": false,
          "description": "通话唯一标识 callId，即直拨呼叫响应中返回的 callId"
        },
        {
          "name": "Src",
          "type": "string",
          "required": false,
          "description": "查询主叫用户产生的呼叫话单（0086开头），设置为空表示拉取该时间段的所有话单"
        },
        {
          "name": "StartTimeStamp",
          "type": "string",
          "required": false,
          "description": "话单开始时间戳"
        },
        {
          "name": "EndTimeStamp",
          "type": "string",
          "required": false,
          "description": "话单结束时间戳"
        }
      ],
      "required": [
        "BizAppId"
      ]
    },
    {
      "name": "GetVirtualNum",
      "description": "直拨获取中间号（App 使用方发起）",
      "parameters": [
        {
          "name": "BizAppId",
          "type": "string",
          "required": true,
          "description": "业务appid"
        },
        {
          "name": "Dst",
          "type": "string",
          "required": true,
          "description": "被叫号码(号码前加 0086，如 008613631686024)"
        },
        {
          "name": "Src",
          "type": "string",
          "required": false,
          "description": "主叫号码(号码前加 0086，如 008613631686024)，xb 模式下是不用填写，axb 模式下是必选"
        },
        {
          "name": "AccreditList",
          "type": "array",
          "required": false,
          "description": "{“accreditList”:[“008613631686024”,”008612345678910”]}，主要用于 N-1 场景，号码绑定非共享是独占型，指定了 dst 独占中间号绑定，accreditList 表示这个列表成员可以拨打 dst 绑 定的中间号，默认值为空，表示所有号码都可以拨打独占型中间号绑定，最大集合不允许超过 30 个，仅适用于xb模式",
          "item_type": "string"
        },
        {
          "name": "AssignVirtualNum",
          "type": "string",
          "required": false,
          "description": "指定中间号（格式：008617013541251），如果该中间号已被使用则返回绑定失败。如果不带该字段则由腾讯侧从号码池里自动分配"
        },
        {
          "name": "Record",
          "type": "string",
          "required": false,
          "description": "是否录音，0表示不录音，1表示录音。默认为不录音，注意如果需要录音回调，通话完成后需要等待一段时间，收到录音回调之后，再解绑中间号。"
        },
        {
          "name": "CityId",
          "type": "string",
          "required": false,
          "description": "主被叫显号号码归属地，指定该参数说明显号归属该城市，如果没有该城市号码会随机选取一个城市或者后台配置返回107，返回码详见 《腾讯-中间号-城市id.xlsx》"
        },
        {
          "name": "BizId",
          "type": "string",
          "required": false,
          "description": "应用二级业务 ID，bizId 需保证在该 appId 下全局唯一，最大长度不超过 16 个字节。"
        },
        {
          "name": "MaxAssignTime",
          "type": "string",
          "required": false,
          "description": "号码最大绑定时间，不填默认为 24 小时，最长绑定时间是168小时，单位秒"
        },
        {
          "name": "StatusFlag",
          "type": "string",
          "required": false,
          "description": "主叫发起呼叫状态：1 被叫发起呼叫状态：256 主叫响铃状态：2 被叫响铃状态：512 主叫接听状态：4 被叫接听状态：1024 主叫拒绝接听状态：8 被叫拒绝接听状态：2048 主叫正常挂机状态：16 被叫正常挂机状态：4096 主叫呼叫异常：32 被叫呼叫异常：8192 例如： 值为 0：表示所有状态不需要推送 值为 4：表示只要推送主叫接听状态 值为 16191：表示所有状态都需要推送（上面所有值\ufffd..."
        },
        {
          "name": "StatusUrl",
          "type": "string",
          "required": false,
          "description": "请填写statusFlag并设置值，状态回调通知地址，正式环境可以配置默认推送地址"
        },
        {
          "name": "HangupUrl",
          "type": "string",
          "required": false,
          "description": "话单回调通知地址，正式环境可以配置默认推送地址"
        },
        {
          "name": "RecordUrl",
          "type": "string",
          "required": false,
          "description": "录单 URL 回调通知地址，正式环境可以配置默认推送地址"
        }
      ],
      "required": [
        "BizAppId",
        "Dst"
      ]
    }
  ]
}