Skip to content

Latest commit

History

History
34 lines (25 loc) · 1.83 KB

File metadata and controls

34 lines (25 loc) · 1.83 KB

CodeRequest

Properties

NameTypeDescriptionNotes
tostrThe phone number to send the mfa code to.
var_fromstrThe application phone number, the sender of the mfa code.
application_idstrThe application unique ID, obtained from Bandwidth.
scopestrAn optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to "2FA".[optional]
messagestrThe message format of the mfa code. There are three values that the system will replace "{CODE}", "{NAME}", "{SCOPE}". The "{SCOPE}" and "{NAME} value template are optional, while "{CODE}" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.
digitsintThe number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.

Example

frombandwidth.models.code_requestimportCodeRequest# TODO update the JSON string belowjson="{}"# create an instance of CodeRequest from a JSON stringcode_request_instance=CodeRequest.from_json(json)
# print the JSON string representation of the objectprint(CodeRequest.to_json())
# convert the object into a dictcode_request_dict=code_request_instance.to_dict()
# create an instance of CodeRequest from a dictcode_request_from_dict=CodeRequest.from_dict(code_request_dict)

[Back to Model list][Back to API list][Back to README]