python-callfire 0.10.0

用法

Python方法名遵循CallFire的API。包装器不引入任何比原始API定义的额外的复杂性或约定，使得使用非常直接

>>> from callfire import CallFireAPI
>>> 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方法包含描述查询和体参数的docstrings。官方API文档可在developers.callfire.com找到。