callfire api薄包装。
python-callfire的Python项目详细描述
python中的瘦包装器,它基于swagger规范实现callfire v2接口定义。
用法
python方法名在CallFire’s API后面。 包装器不引入任何额外的复杂性或约定,高于原始API中定义的复杂性或约定。 这使得使用非常简单:
>>>fromcallfireimportCallFireAPI>>>api=CallFireAPI('<api-app-username>','<api-app-password>')>>>api.get_account().json(){u'email':u'your-email@your-domain.com',u'firstName':u'John',u'id':700321776,u'lastName':u'Smith',u'name':u'Metacortex',u'permissions':[u'ACCOUNT_HOLDER']}>>>text=dict(phoneNumber='13408887345',message='Hi!')>>>api.send_texts(body=[text]).json(){u'items':[{u'batchId':11428003374,u'campaignId':60000313259,u'contact':{u'id':152100378045,u'properties':{u'UNDEFINED':u'13471521003'}},u'created':1470222349000,u'finalTextResult':u'SENT',u'fromNumber':u'67076',u'id':1038052003407,u'inbound':False,u'message':u'Hi!',u'modified':1470222348000,u'records':[{u'billedAmount':1.0,u'finishTime':1470222349000,u'id':579287900394,u'message':u'Hi!',u'textResult':u'SENT'}],u'state':u'FINISHED',u'toNumber':u'13408887345'}]}>>>broadcast=dict(fromNumber='13471521003',labels=['via-api'],name='Test voice broadcast'),answeringMachineConfig='AM_AND_LIVE',recipients=[dict(phoneNumber='(347) 1521003')],sounds=dict(liveSoundText='Voice message',machineSoundText='Voice message'))>>>api.create_call_broadcast(query=dict(start=True),body=broadcast).json(){u'id':13750937003}>>>api.get_call_broadcast(13750937003).json(){u'id':13750937003,...u'status':u'FINISHED'}
错误处理
每当发生低级异常时,它将被包装并重新引发为callfireerror, 同时保留并显示原始回溯,并且原始异常也是 可在wrapped_exc属性下进行检查。
文档
生成的python方法确实包含具有所述查询和body参数的docstring。 官方api文档可在developers.callfire.com获得。