更新时间:2021-09-18 GMT+08:00
分享

Python

环境要求

Python 3.0及以上版本。

引用库

requests 2.18.1

  1. 请自行下载安装Python 3.x,并完成环境配置。

  2. 打开命令行窗口,执行pip install requests命令。

  3. 执行pip list查看安装结果。

  • 本文档所述Demo在提供服务的过程中,可能会涉及个人数据的使用,建议您遵从国家的相关法律采取足够的措施,以确保用户的个人数据受到充分的保护。
  • 本文档所述Demo仅用于功能演示,不允许客户直接进行商业使用。
  • 本文档信息仅供参考,不构成任何要约或承诺。

“语音通知API”代码样例

 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
26
27
28
29
30
31
32
33
34
35
36
37
38
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
# -*- coding: utf-8 -*-
import base64
import hashlib
import requests #需要先使用pip install requests命令安装依赖
import time
import uuid

#必填,请参考"开发准备-申请资源"获取如下数据,替换为实际值
base_url = 'https://{domain}:{port}'#APP接入地址,购买服务时下发,请替换为实际值
appKey = '***appKey***'#语音通知应用的appKey,购买服务时下发,请替换为实际值
appSecret = '***appSecret***'#语音通知应用的appSecret,购买服务时下发,请替换为实际值

def buildWSSEHeader(appKey, appSecret):
    now = time.strftime('%Y-%m-%dT%H:%M:%SZ') #Created
    nonce = str(uuid.uuid4()).replace('-', '') #Nonce
    digest = hashlib.sha256((nonce + now + appSecret).encode()).hexdigest()
    digestBase64 = base64.b64encode(digest.encode()).decode() #PasswordDigest
    return 'UsernameToken Username="{}",PasswordDigest="{}",Nonce="{}",Created="{}"'.format(appKey, digestBase64, nonce, now);

def voiceNotifyAPI(displayNbr, calleeNbr, playInfoList):
    if len(displayNbr) < 1 or len(calleeNbr) < 1 or playInfoList is None:
        return

    apiUri = '/rest/httpsessions/callnotify/v2.0' #v1.0 or v2.0
    requestUrl = base_url + apiUri

    header = {
        'Content-Type': 'application/json;charset=UTF-8',
        'Authorization': 'WSSE realm="SDP",profile="UsernameToken",type="Appkey"',
        'X-WSSE': buildWSSEHeader(appKey, appSecret)
    }

    jsonData = {
        # 必填参数
        'displayNbr': displayNbr,#主叫用户手机终端的来电显示号码。
        'calleeNbr': calleeNbr,#发起呼叫时所拨打的被叫号码。
        'playInfoList': playInfoList#播放信息列表,最大支持5个,每个播放信息携带的参数都可以不相同。
        # 选填参数
#         'statusUrl': '', #设置SP接收状态上报的URL,要求使用BASE64编码
#         'feeUrl': '', #设置SP接收话单上报的URL,要求使用BASE64编码
#         'returnIdlePort': 'false', #指示是否需要返回平台空闲呼叫端口数量
#         'userData': 'customerId123' #设置用户的附属信息
    }

    try:
        r = requests.post(requestUrl, json=jsonData, headers=header, verify=False)
        print(r.text) #打印响应结果
    except requests.exceptions.HTTPError as e:
        print(e.code)
        print(e.read().decode('utf-8')) #打印错误信息
    pass

def getPlayInfoList(notifyVoice, templateId, templateParas):
    playInfoList = [{
        'notifyVoice': notifyVoice,
        'templateId': templateId,
        'templateParas': templateParas
#         'collectInd': 0, #是否进行收号
#         'replayAfterCollection': 'false', #设置是否在收号后重新播放notifyVoice或templateId指定的放音
#         'collectContentTriggerReplaying': '1' #设置触发重新放音的收号内容
    }]
    return playInfoList

if __name__ == '__main__':
    playInfoList = getPlayInfoList('notifyvoice.wav', 'xxxxxx', ['3', '人民公园正门'])
    voiceNotifyAPI('+86531*******4', '+86135*******1', playInfoList)

“呼叫状态通知API”代码样例

  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
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 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
# -*- coding: utf-8 -*-
'''
呼叫事件通知
客户平台收到语音通话平台的呼叫事件通知的接口通知
'''
import json

#呼叫事件通知样例
jsonBody = json.dumps({
    'eventType': 'callout',
    'statusInfo': {
        'sessionId': '1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com',
        'timestamp': '2019-01-24 03:04:24',
        'caller': '+86138*******2',
        'called': '+86138*******1',
        'userData': 'customerId123'
    }
}).encode('ascii')

print(jsonBody)

'''
呼叫事件通知
@see: 详细内容以接口文档为准
@param param: jsonBody
@return: 
'''
def onCallEvent(jsonBody):
    jsonObj = json.loads(jsonBody) #将通知消息解析为jsonObj
    eventType = jsonObj['eventType'] #通知事件类型

    if ('fee' == eventType):
        print('EventType error: ' + eventType)
        return

    if ('statusInfo' not in jsonObj):
        print('param error: no statusInfo.')
        return
    statusInfo = jsonObj['statusInfo'] #呼叫状态事件信息

    print('eventType: ' + eventType) #打印通知事件类型
   
    #callout:呼出事件
    if ('callout' == eventType):
        '''
        Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理

        'timestamp': 该呼叫事件发生时语音通话平台的UNIX时间戳
        'userData': 用户附属信息
        'sessionId': 通话链路的标识ID
        'caller': 主叫号码
        'called': 被叫号码
        '''
        if ('sessionId' in statusInfo):
            print('sessionId: ' + statusInfo['sessionId'])
        return
    #alerting:振铃事件
    if ('alerting' == eventType):
        '''
        Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理

        'timestamp': 该呼叫事件发生时语音通话平台的UNIX时间戳
        'userData': 用户附属信息
        'sessionId': 通话链路的标识ID
        'caller': 主叫号码
        'called': 被叫号码
        '''
        if ('sessionId' in statusInfo):
            print('sessionId: ' + statusInfo['sessionId'])
        return
    #answer:应答事件
    if ('answer' == eventType):
        '''
        Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理

        'timestamp': 该呼叫事件发生时语音通话平台的UNIX时间戳
        'userData': 用户附属信息
        'sessionId': 通话链路的标识ID
        'caller': 主叫号码
        'called': 被叫号码
        '''
        if ('sessionId' in statusInfo):
            print('sessionId: ' + statusInfo['sessionId'])
        return
    #collectInfo:放音收号结果事件,仅应用于语音通知场景
    if ('collectInfo' == eventType):
        '''
        Example: 此处以解析digitInfo为例,请按需解析所需参数并自行实现相关处理

        'timestamp': 该呼叫事件发生时语音通话平台的UNIX时间戳
        'sessionId': 通话链路的标识ID
        'digitInfo': 放音收号场景中,语音通话平台对开发者进行放音收号操作的结果描述
        '''
        if ('digitInfo' in statusInfo):
            print('digitInfo: ' + statusInfo['digitInfo'])
        return
    #disconnect:挂机事件
    if ('disconnect' == eventType):
        '''
        Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理

        'timestamp': 该呼叫事件发生时语音通话平台的UNIX时间戳
        'userData': 用户附属信息
        'sessionId': 通话链路的标识ID
        'caller': 主叫号码
        'called': 被叫号码
        'partyType': 挂机的用户类型,仅在语音回呼场景携带
        'stateCode': 通话挂机的原因值
        'stateDesc': 通话挂机的原因值的描述
        '''
        if ('sessionId' in statusInfo):
            print('sessionId: ' + statusInfo['sessionId'])
        return

if __name__ == '__main__':
    onCallEvent(jsonBody) #呼叫事件处理

“话单通知API”代码样例

 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
26
27
28
29
30
31
32
33
34
35
36
37
38
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
# -*- coding: utf-8 -*-
'''
话单通知
客户平台收到语音通话平台的话单通知的接口通知
'''
import json

#话单通知样例
jsonBody = json.dumps({
    'eventType': 'fee',
    'feeLst': [
        {
            'direction': 0, #通话的呼叫方向,以语音通话平台为基准
            'spId': 'CaaS_Test_01', #客户的云服务账号
            'appKey': 'ka4k******9YnEm2', #应用的app_key
            'icid': 'CAE-20190124110424-12019775', #呼叫记录的唯一标识
            'bindNum': '+86755*******8', #发起此次呼叫的CallEnabler业务号码,即绑定号码
            'sessionId': '1201_612_4294967295_20190124030424@callenabler245.huaweicaas.com', #通话链路的唯一标识
            'callerNum': '+86138*******2', #主叫号码
            'calleeNum': '+86138*******1', #被叫号码
            'fwdDisplayNum': '+86138*******2', #转接呼叫时的显示号码(仅语音回呼场景携带)
            'fwdDstNum': '+86138*******1', #转接呼叫时的转接号码(仅语音回呼场景携带)
           
            'fwdStartTime': '2019-01-24 03:04:31', #转接呼叫操作的开始时间(仅语音回呼场景携带)
            'fwdAlertingTime': '2019-01-24 03:04:36', #转接呼叫操作后的振铃时间(仅语音回呼场景携带)
            'fwdAnswerTime': '2019-01-24 03:04:38', #转接呼叫操作后的应答时间(仅语音回呼场景携带)
            'callEndTime': '2019-01-24 03:04:49', #呼叫结束时间
            'fwdUnaswRsn': 0, #转接呼叫操作失败的Q850原因值
            'failTime': '', #呼入,呼出的失败时间
            'ulFailReason': 0, #通话失败的拆线点
            'sipStatusCode': 0, #呼入,呼出的失败SIP状态码
            'callOutStartTime': '2019-01-24 03:04:24', #Initcall的呼出开始时间
            'callOutAlertingTime': '2019-01-24 03:04:27', #Initcall的呼出振铃时间
            'callOutAnswerTime': '2019-01-24 03:04:31', #Initcall的呼出应答时间
            'callOutUnaswRsn': 0, #Initcall的呼出失败的Q850原因值
            'dynIVRStartTime': '', #自定义动态IVR开始时间(仅语音通知场景携带)
            'dynIVRPath': '', #自定义动态IVR按键路径(仅语音通知场景携带)
            'recordFlag': 0, #录音标识
            'recordStartTime': '', #录音开始时间(仅语音回呼场景携带)
            'recordObjectName': '', #录音文件名(仅语音回呼场景携带)
            'recordBucketName': '', #录音文件所在的目录名(仅语音回呼场景携带)
            'recordDomain': '', #存放录音文件的域名(仅语音回呼场景携带)
            'recordFileDownloadUrl': '', #录音文件下载地址(仅语音回呼场景携带)
            'ttsPlayTimes': 0, #应用TTS功能时,使用TTS的总次数
            'ttsTransDuration': 0, #应用TTS功能时,TTS Server进行TTS转换的总时长(单位为秒)
            'serviceType': '002', #携带呼叫的业务类型信息
            'hostName': 'callenabler245.huaweicaas.com', #话单生成的服务器设备对应的主机名
            'userData': '' #用户附属信息
        }
    ]
}).encode('ascii')

print(jsonBody)

'''
话单通知
@see: 详细内容以接口文档为准
@param param: jsonBody
@return: 
'''
def onFeeEvent(jsonBody):
    jsonObj = json.loads(jsonBody) #将通知消息解析为jsonObj
    eventType = jsonObj['eventType'] #通知事件类型

    if ('fee' != eventType):
        print('EventType error: ' + eventType)
        return

    if ('feeLst' not in jsonObj):
        print('param error: no feeLst.');
        return

    feeLst = jsonObj['feeLst']

    #Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
    #短时间内有多个通话结束时语音通话平台会将话单合并推送,每条消息最多携带50个话单
    if (len(feeLst) > 1):
        for loop in feeLst:
            if ('sessionId' in loop):
                print('sessionId: ' + loop['sessionId'])
    elif(len(feeLst) == 1):
        if ('sessionId' in feeLst[0]):
            print('sessionId: ' + feeLst[0]['sessionId'])
    else:
        print('feeLst error: no element.');

if __name__ == '__main__':
    onFeeEvent(jsonBody) #话单处理
分享:

    相关文档

    相关产品

close