云客智能语音客服接口文档

云客智能语音客服接口文档


1.2获取api_key(api_access_id方式)

<p><strong>简要描述:</strong> </p> <ul> <li> <p>获取api_key接口作为其他接口的基础接口,主要通过此接口获得api_key跟user_sn用于请求其他接口,api_key有效时间为俩小时,过期了需要重新请求一次登录接口获得旧的api_key。</p> </li> <li>6.6版本以上支持</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{BaseUrl}/api/login</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>请求示例</strong></p> <pre><code class="language-json">{“api_access_id”: “a655f309e7d7b404f4b6b898688ff50d”, “from”: “1”, ”sign”: “0bf4482eac6ac7ae68813905aa26b2b4”, ”timestamp”: “2024-09-24 09:34:25”}</code></pre> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">api_access_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>接口调用api_access_id</td> </tr> <tr> <td style="text-align: left;">from</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>请求方式 :填1</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>秘钥,生成方式:md5(api_access_id+api_access_secret+timestamp)</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>当前时间(五分钟内),格式:Y-m-d H:i:s</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code>{ &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;id&amp;quot;: 3635, &amp;quot;user_sn&amp;quot;: &amp;quot;SYSUSER|b3397882e26ba9e7fb8f01f1af345bde&amp;quot;, &amp;quot;user_name&amp;quot;: &amp;quot;zzh&amp;quot;, &amp;quot;team_name&amp;quot;: &amp;quot;人工智能客户组&amp;quot;, &amp;quot;team_sn&amp;quot;: &amp;quot;SON&amp;quot;, &amp;quot;salt&amp;quot;: null, &amp;quot;passwd&amp;quot;: &amp;quot;$2y$10$V1/8xg7Mq5YnEMfMYIef7evQCtIzdB4eW5Q9TvK97OnD/XmVC0Evi&amp;quot;, &amp;quot;blocked&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;bindip&amp;quot;: null, &amp;quot;expired&amp;quot;: &amp;quot;2026-08-31&amp;quot;, &amp;quot;amount&amp;quot;: 1, &amp;quot;give_amount&amp;quot;: 0, &amp;quot;priority&amp;quot;: null, &amp;quot;status&amp;quot;: null, &amp;quot;contact&amp;quot;: &amp;quot;郑志焕&amp;quot;, &amp;quot;email&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;qq&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;wangwang&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;mobile&amp;quot;: null, &amp;quot;phone&amp;quot;: null, &amp;quot;ext&amp;quot;: &amp;quot;888999&amp;quot;, &amp;quot;fax&amp;quot;: null, &amp;quot;fax_ext&amp;quot;: null, &amp;quot;local_phone&amp;quot;: null, &amp;quot;is_staff&amp;quot;: null, &amp;quot;is_active&amp;quot;: 2, &amp;quot;forward_phones&amp;quot;: null, &amp;quot;channel&amp;quot;: null, &amp;quot;display_phone&amp;quot;: null, &amp;quot;secret&amp;quot;: null, &amp;quot;defaultringgroup&amp;quot;: null, &amp;quot;gatewayaddr&amp;quot;: null, &amp;quot;sipname&amp;quot;: &amp;quot;zb888999&amp;quot;, &amp;quot;sippwd&amp;quot;: null, &amp;quot;sipproxy&amp;quot;: null, &amp;quot;enabled&amp;quot;: null, &amp;quot;isswitch&amp;quot;: null, &amp;quot;linkext&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;hide_callid&amp;quot;: null, &amp;quot;enable_record&amp;quot;: null, &amp;quot;yd_display_phone&amp;quot;: null, &amp;quot;remember_token&amp;quot;: &amp;quot;Sa0woa3azaRE8K0x8IHApgulqsX8PDlAZkVLo6X5Dyepd23AImJhOl35x2ao&amp;quot;, &amp;quot;created_at&amp;quot;: &amp;quot;2018-12-04 17:20:58&amp;quot;, &amp;quot;updated_at&amp;quot;: &amp;quot;2024-07-12 12:39:33&amp;quot;, &amp;quot;phone_type&amp;quot;: null, &amp;quot;is_order&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;dep_phone&amp;quot;: null, &amp;quot;company&amp;quot;: null, &amp;quot;total_count&amp;quot;: 0, &amp;quot;trunkgroup_id&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;parent_sn&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;concurrency&amp;quot;: null, &amp;quot;max_call_count&amp;quot;: 14, &amp;quot;ai_count&amp;quot;: 100, &amp;quot;start_at_one&amp;quot;: &amp;quot;08:30:00&amp;quot;, &amp;quot;end_at_one&amp;quot;: &amp;quot;12:30:00&amp;quot;, &amp;quot;start_at_two&amp;quot;: &amp;quot;13:30:00&amp;quot;, &amp;quot;end_at_two&amp;quot;: &amp;quot;21:00:00&amp;quot;, &amp;quot;start_at_three&amp;quot;: null, &amp;quot;end_at_three&amp;quot;: null, &amp;quot;start_at_four&amp;quot;: null, &amp;quot;end_at_four&amp;quot;: null, &amp;quot;project_sn&amp;quot;: &amp;quot;projects|1e99759eee92f3f8f0cd3649b4ffda96,projects|4a92f90b5339646b36e9805600820deb,projects|808dfdcb369470376086281d2fdf26a0,projects|5321ee12e21b9467f74a98488e07a8b4,projects|e5b1b8d0f503edab6d5425f91d405a35,projects|648aca1c1ab7f23eab195d02a52052ee,project|a9ade5d7f10b74b66fb32495b66b6a09,project|9ab8f8343f4df4d02787026d03732eeb,projects|840d68a964b8533a63f39cd6f484a4e6,projects|941b663b4f6bef79c0e5f096d173351a,project|0adb8f8cf37e8fb1a785f0605394ce6e,projects|edc0c84159c69dc8a60f360c564d9e80,project|4db886c528383a1120929896d7909d4a,projects|3ae34d77b8c93d8c05036beea1318bf9,project|c4c87e02795564d384c05045235acb90,projects|0b0bb0cc1a75d80ccb681e79fb1ceb19,projects|3a4197ee15668b5b3530d182afc19df2,projects|55581589145ce56d81a161cff3f11781,projects|dc63dfc04d227c34fbe47f38636e4d43,project|1069978be86a36d707af92d016aa18c8,projects|2fa651a14418d1ca536e68b3f81707ba,projects|6468ffd6eac9e3e630f8d991c49ddb34,project|24503865dfcffe8d798a7449eb313feb,projects|061f1b59707b0ae6fc303ced37155141,projects|bfca8e9779e7610d329b9e61a290b75e,projects|d919f1e29c84b2cdd57478894a233bb3,project|9e6f8440cfe587a4d3773eb0012105dc,projects|7c6c95a20d43f1aadfa75b3f3a494343,project|21a55abfb1769a458794773e35e2306b,projects|65f5bd63a1d6765562f0288ce7bec130,projects|2657330a4f82b6828a96a98177ccac21,project|d40c01fc8881579d212076a747ce0bbb,projects|74b4995e21375746bd9362ebf417b2cb,project|18912021113fb33301878d81150ce211,projects|837371e6eaf5a3388ce5c69b25419f3c,projects|c965dfd067ea948e58c324e578dd147e,projects|c965dfd067ea948e58c324e578dd147e,project|b870332c9845901e1d528087c05d212b,projects|d98f8ed376820d8a316954d52a44e50a,projects|c35d5e7d47180eb36b5fae85c9b79be1,projects|61b663bc358c392fbccad2b5c0105c84&amp;quot;, &amp;quot;caller_group&amp;quot;: &amp;quot;888999,888999,200050,200053,888998,200049,200088,900002&amp;quot;, &amp;quot;skillgroup_sn&amp;quot;: null, &amp;quot;callin_project_sn&amp;quot;: null, &amp;quot;dial_span&amp;quot;: 1000, &amp;quot;callin_phone&amp;quot;: &amp;quot;970085,66866021,970087,886520865,02039723245,61982107,61982108&amp;quot;, &amp;quot;api_user_id&amp;quot;: 0, &amp;quot;api_domain&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;api_eid&amp;quot;: 0, &amp;quot;api_account&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;api_pwd&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;ext_max&amp;quot;: &amp;quot;100&amp;quot;, &amp;quot;remark&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;api_key&amp;quot;: &amp;quot;mQ1ZMmjZ&amp;quot;, &amp;quot;api_key_expire&amp;quot;: 1720767089, &amp;quot;open_interface&amp;quot;: 1, &amp;quot;api_auto_cio&amp;quot;:&amp;quot;{\&amp;quot;autoSetting\&amp;quot;:\&amp;quot;open\&amp;quot;,\&amp;quot;api_username\&amp;quot;:\&amp;quot;\高\沛\&amp;quot;,\&amp;quot;check_lb\&amp;quot;:\&amp;quot;13819,13819,13731,,,\&amp;quot;}&amp;quot;, &amp;quot;api_auto_status&amp;quot;: null, &amp;quot;api_id&amp;quot;: 0, &amp;quot;api_verify&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;api_check_time&amp;quot;: &amp;quot;1593593024&amp;quot;, &amp;quot;caller_number&amp;quot;: null, &amp;quot;open_sms&amp;quot;: 1, &amp;quot;oper_id&amp;quot;: 75, &amp;quot;website&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;industry&amp;quot;: &amp;quot;小贷行业&amp;quot;, &amp;quot;city&amp;quot;: &amp;quot;深圳&amp;quot;, &amp;quot;last_login_time&amp;quot;: &amp;quot;2024-07-09 15:09:04&amp;quot;, &amp;quot;need_fix_tel&amp;quot;: 0, &amp;quot;area_code&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;callback_url&amp;quot;: &amp;quot;https://adebf652-a052-443a-a337-8ff161ed19de.mock.pstmn.io&amp;quot;, &amp;quot;open_callback&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;time_type&amp;quot;: 1, &amp;quot;is_aent_admin&amp;quot;: null, &amp;quot;account_belong&amp;quot;: &amp;quot;admin&amp;quot;, &amp;quot;job&amp;quot;: &amp;quot;管理员&amp;quot;, &amp;quot;callout_project_sn&amp;quot;: null, &amp;quot;connection_rate_warning&amp;quot;: 5, &amp;quot;warning_stop_call&amp;quot;: 0, &amp;quot;bind_phone&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;industry_id&amp;quot;: &amp;quot;1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,27,28,29,30,31,32,33,34,35,36,37,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,133,135,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,289,292,293,297,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,328,329,330,331,332,333,334,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,406,407,408,409,410,411,412,413,415,416&amp;quot;, &amp;quot;test_project_sn&amp;quot;: &amp;quot;project|21a55abfb1769a458794773e35e2306b&amp;quot;, &amp;quot;organization_id&amp;quot;: 0, &amp;quot;analysis_callback_url&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;callback_interval_time&amp;quot;: 0, &amp;quot;date_str&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;open_number_check&amp;quot;: 0, &amp;quot;number_check_total&amp;quot;: 0, &amp;quot;used_number_check&amp;quot;: 0, &amp;quot;sdzj_phone&amp;quot;: null, &amp;quot;login_phone&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;is_global_hide&amp;quot;: 0, &amp;quot;hm_data_analysis&amp;quot;: 1, &amp;quot;hm_preference_setting&amp;quot;: &amp;quot;{\&amp;quot;single_ai_sends_per_day\&amp;quot;:\&amp;quot;500\&amp;quot;,\&amp;quot;single_ai_hangon_per_day\&amp;quot;:\&amp;quot;300\&amp;quot;,\&amp;quot;single_seat_intervention_per_day\&amp;quot;:\&amp;quot;150\&amp;quot;,\&amp;quot;single_seat_intension_per_day\&amp;quot;:\&amp;quot;30\&amp;quot;}&amp;quot;, &amp;quot;start_at&amp;quot;: &amp;quot;00:00&amp;quot;, &amp;quot;end_at&amp;quot;: &amp;quot;23:50&amp;quot;, &amp;quot;ringing_time&amp;quot;: 45, &amp;quot;task_callback_url&amp;quot;: &amp;quot;https://ae81c919-f263-4bbb-afda-b07ad0802d64.mock.pstmn.io&amp;quot;, &amp;quot;periods&amp;quot;: &amp;quot;[{\&amp;quot;start_at\&amp;quot;:\&amp;quot;08:30:00\&amp;quot;,\&amp;quot;end_at\&amp;quot;:\&amp;quot;22:01:00\&amp;quot;}]&amp;quot;, &amp;quot;min_dial_span&amp;quot;: 1000, &amp;quot;organization_name&amp;quot;: null, &amp;quot;wx_pushed_config&amp;quot;: &amp;quot;{\&amp;quot;mode\&amp;quot;:1,\&amp;quot;classify\&amp;quot;:\&amp;quot;A,B,C,D\&amp;quot;,\&amp;quot;interval_min\&amp;quot;:1,\&amp;quot;update_time\&amp;quot;:1700048960}&amp;quot;, &amp;quot;classification_must_fill&amp;quot;: 0, &amp;quot;open_nlp&amp;quot;: 1, &amp;quot;flash_oper_id&amp;quot;: null, &amp;quot;open_manual_asr&amp;quot;: 1, &amp;quot;manual_call_channel&amp;quot;: 100, &amp;quot;manual_call_channel_lock&amp;quot;: 1, &amp;quot;number_check_type&amp;quot;: &amp;quot;empty&amp;quot;, &amp;quot;number_check_total_basic&amp;quot;: 0, &amp;quot;used_number_check_basic&amp;quot;: 0, &amp;quot;is_change_pwd&amp;quot;: 1, &amp;quot;open_auto_add_wechat&amp;quot;: 1, &amp;quot;add_wechat_max&amp;quot;: 50, &amp;quot;first_order_time&amp;quot;: null, &amp;quot;is_searvistor&amp;quot;: 0, &amp;quot;man_machine_seats_count&amp;quot;: 80, &amp;quot;seats_count&amp;quot;: 20, &amp;quot;add_wechat_type&amp;quot;: 1, &amp;quot;is_local&amp;quot;: 1, &amp;quot;total_minutes&amp;quot;: 0, &amp;quot;balance_minutes&amp;quot;: 0, &amp;quot;extend_months&amp;quot;: 0 }, &amp;quot;msg&amp;quot;: &amp;quot;login success&amp;quot; } </code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">user_name</td> <td>string</td> <td>用户名;</td> </tr> <tr> <td style="text-align: left;">user_sn</td> <td>string</td> <td>用户唯一标识符;</td> </tr> <tr> <td style="text-align: left;">team_name</td> <td>string</td> <td>团队名称;</td> </tr> <tr> <td style="text-align: left;">team_sn</td> <td>string</td> <td>团队唯一标识符;</td> </tr> <tr> <td style="text-align: left;">expired</td> <td>string</td> <td>账号过期时间;</td> </tr> <tr> <td style="text-align: left;">ai_count</td> <td>string</td> <td>ai数量;</td> </tr> <tr> <td style="text-align: left;">caller_group</td> <td>string</td> <td>电话组;</td> </tr> <tr> <td style="text-align: left;">parent_sn</td> <td>string</td> <td>父级账号(为空表示主账号)</td> </tr> <tr> <td style="text-align: left;">api_key</td> <td>string</td> <td>请求秘钥</td> </tr> <tr> <td style="text-align: left;">api_key_expire</td> <td>string</td> <td>请求秘钥过期时间(俩小时内有效)</td> </tr> <tr> <td style="text-align: left;">job</td> <td>string</td> <td>账号权限名称</td> </tr> </tbody> </table> <p><strong>返回参数code说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">0</td> <td>登录成功</td> </tr> <tr> <td style="text-align: left;">10001</td> <td>验证不通过,数据可能被劫持</td> </tr> <tr> <td style="text-align: left;">20001</td> <td>数据传输方式不正确</td> </tr> <tr> <td style="text-align: left;">20002</td> <td>数据格式错误(少传公共参数)</td> </tr> <tr> <td style="text-align: left;">20003</td> <td>该类型客户端不存在</td> </tr> <tr> <td style="text-align: left;">20004</td> <td>用户名和密码错误</td> </tr> <tr> <td style="text-align: left;">20005</td> <td>api_key验证不通过</td> </tr> <tr> <td style="text-align: left;">20006</td> <td>api_key过期</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML