ast_callerid Struct Reference
Structure for all kinds of caller ID identifications. More...
#include <channel.h>
Data Fields | |
| char * | cid_ani |
| Malloc'd Automatic Number Identification (ANI) (Field will eventually move to struct ast_channel.caller.ani). | |
| int | cid_ani2 |
| Callerid ANI 2 (Info digits) (Field will eventually move to struct ast_channel.caller.ani2). | |
| char * | cid_dnid |
| Malloc'd Dialed Number Identifier (Field will eventually move to struct ast_channel.dialed.number). | |
| char * | cid_name |
| Malloc'd Caller Name (ASCII) (Field will eventually move to struct ast_channel.caller.id.name). | |
| char * | cid_num |
| Malloc'd Caller Number (Field will eventually move to struct ast_channel.caller.id.number). | |
| int | cid_pres |
| Callerid Q.931 encoded number presentation/screening fields (Field will eventually move to struct ast_channel.caller.id.number_presentation). | |
| char * | cid_tag |
| Callerid "Tag" A user-settable field used to help associate some extrinsic information about the channel or user of the channel to the caller ID. This information is not transmitted over the wire and so is only useful within an Asterisk environment. (Field will eventually move to struct ast_channel.caller.id.tag). | |
| int | cid_tns |
| Callerid Transit Network Select. | |
| int | cid_ton |
| Callerid Q.931 encoded type-of-number/numbering-plan fields. | |
| struct ast_party_subaddress | dialed_subaddress |
| Dialed/Called subaddress. (Field will eventually move to struct ast_channel.dialed.subaddress). | |
| struct ast_party_subaddress | subaddress |
| Caller id subaddress. (Field will eventually move to struct ast_channel.caller.id.subaddress). | |
Detailed Description
Structure for all kinds of caller ID identifications.
- Note:
- All string fields here are malloc'ed, so they need to be freed when the structure is deleted. Also, NULL and "" must be considered equivalent.
SIP and IAX2 has utf8 encoded Unicode caller ID names. In some cases, we also have an alternative (RPID) E.164 number that can be used as caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to PSTN gateway).
- Todo:
- Implement settings for transliteration between UTF8 caller ID names in to Ascii Caller ID's (DAHDI). Östen Åsklund might be transliterated into Osten Asklund or Oesten Aasklund depending upon language and person... We need automatic routines for incoming calls and static settings for our own accounts.
Definition at line 237 of file channel.h.
Field Documentation
| char* cid_ani |
Malloc'd Automatic Number Identification (ANI) (Field will eventually move to struct ast_channel.caller.ani).
Definition at line 260 of file channel.h.
Referenced by __analog_handle_event(), __oh323_new(), ast_cel_fabricate_channel_from_event(), ast_cel_report_event(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_iax2_new(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_set_callerid(), ast_var_channels_table(), callerid_read(), dahdi_handle_event(), dahdi_new(), free_cid(), isAnsweringMachine(), jingle_new(), mgcp_new(), mgcp_ss(), misdn_new(), oss_new(), set_one_cid(), sip_new(), skinny_new(), skinny_newcall(), and usbradio_new().
| int cid_ani2 |
Callerid ANI 2 (Info digits) (Field will eventually move to struct ast_channel.caller.ani2).
Definition at line 272 of file channel.h.
Referenced by __analog_handle_event(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_str_retrieve_variable(), ast_var_channels_table(), callerid_read(), callerid_write(), dahdi_handle_event(), dahdi_new(), and setup_env().
| char* cid_dnid |
Malloc'd Dialed Number Identifier (Field will eventually move to struct ast_channel.dialed.number).
Definition at line 242 of file channel.h.
Referenced by __oh323_new(), ast_cel_fabricate_channel_from_event(), ast_cel_report_event(), ast_iax2_new(), ast_var_channels_table(), callerid_read(), callerid_write(), dahdi_new(), dial_exec_full(), free_cid(), gtalk_new(), handle_showchan(), iax2_call(), jingle_new(), local_call(), mgcp_ss(), oss_call(), oss_new(), ring_entry(), serialize_showchan(), set_one_cid(), setup_env(), sip_new(), and usbradio_new().
| char* cid_name |
Malloc'd Caller Name (ASCII) (Field will eventually move to struct ast_channel.caller.id.name).
Definition at line 254 of file channel.h.
Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_channel_alloc_ap(), action_meetmelist(), action_status(), analog_call(), analog_handle_dtmfup(), analog_send_callerid(), analog_ss_thread(), ast_cel_fabricate_channel_from_event(), ast_cel_report_event(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_hangup(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_set_callerid(), ast_setstate(), ast_var_channels_table(), blacklist_read(), builtin_atxfer(), callerid_read(), cc_generic_agent_init(), conf_run(), console_call(), copy_message(), dahdi_handle_event(), dial_trunk(), do_forward(), do_immediate_setup(), findmeexec(), forward_message(), free_cid(), handle_cli_misdn_show_channels(), handle_showchan(), join_queue(), leave_voicemail(), manager_parking_status(), manager_queues_status(), meetme_show_cmd(), mgcp_hangup(), minivm_notify_exec(), misdn_hangup(), my_send_callerid(), oss_call(), park_call_full(), park_exec_full(), parkandannounce_exec(), post_manager_event(), print_bc_info(), release_chan(), report_new_callerid(), ring_entry(), rpt_call(), run_externnotify(), senddialevent(), serialize_showchan(), set_one_cid(), setup_env(), skinny_indicate(), sla_ring_station(), state_notify_build_xml(), unistim_new(), and usbradio_new().
| char* cid_num |
Malloc'd Caller Number (Field will eventually move to struct ast_channel.caller.id.number).
Definition at line 248 of file channel.h.
Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_channel_alloc_ap(), __ast_goto_if_exists(), __ast_pbx_run(), _macro_exec(), acf_isexten_exec(), action_agents(), action_coreshowchannels(), action_meetmelist(), action_status(), agentmonitoroutgoing_exec(), analog_call(), analog_handle_dtmfup(), analog_send_callerid(), analog_ss_thread(), ast_app_dtget(), ast_bridge_call(), ast_cel_fabricate_channel_from_event(), ast_cel_report_event(), ast_channel_bridge(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_hangup(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_set_callerid(), ast_setstate(), ast_var_channels_table(), background_detect_exec(), blacklist_read(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), builtin_blindtransfer(), callerid_read(), cc_generic_agent_init(), collect_digits(), conf_run(), console_call(), console_transfer(), copy_message(), dahdi_call(), dahdi_handle_dtmfup(), dahdi_handle_event(), dial_exec_full(), dial_trunk(), disa_exec(), do_forward(), do_immediate_setup(), find_matching_endwhile(), findmeexec(), forward_message(), free_cid(), gosub_exec(), handle_cli_misdn_show_channels(), handle_gosub(), handle_setpriority(), handle_showchan(), isexten_function_read(), join_queue(), leave_voicemail(), local_call(), manager_bridge_event(), manager_parking_status(), manager_queues_status(), meetme_show_cmd(), mgcp_hangup(), mgcp_ss(), minivm_greet_exec(), minivm_notify_exec(), misdn_hangup(), misdn_write(), my_handle_dtmfup(), my_send_callerid(), ospauth_exec(), osplookup_exec(), oss_call(), park_call_full(), park_exec_full(), parkandannounce_exec(), pbx_builtin_background(), pbx_builtin_waitexten(), pbx_parseable_goto(), phase_e_handler(), post_manager_event(), print_bc_info(), privacy_exec(), process_ast_dsp(), queue_exec(), readexten_exec(), release_chan(), report_new_callerid(), ring_entry(), rpt_call(), rpt_exec(), run_externnotify(), senddialevent(), serialize_showchan(), set_one_cid(), setup_env(), setup_privacy_args(), sip_read(), skinny_indicate(), skinny_ss(), sla_ring_station(), sms_exec(), state_notify_build_xml(), unistim_new(), update_connectedline(), usbradio_new(), valid_exit(), vm_authenticate(), waitstream_core(), write_metadata(), and zapateller_exec().
| int cid_pres |
Callerid Q.931 encoded number presentation/screening fields (Field will eventually move to struct ast_channel.caller.id.number_presentation).
Definition at line 266 of file channel.h.
Referenced by __oh323_new(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_iax2_new(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_str_retrieve_variable(), ast_var_channels_table(), callerid_read(), callerid_write(), callerpres_read(), callerpres_write(), cb_events(), dahdi_new(), gtalk_new(), jingle_new(), privacy_exec(), report_new_callerid(), ring_entry(), setcallerid_pres_exec(), setup_env(), sip_call(), sip_new(), and socket_process().
| char* cid_tag |
Callerid "Tag" A user-settable field used to help associate some extrinsic information about the channel or user of the channel to the caller ID. This information is not transmitted over the wire and so is only useful within an Asterisk environment. (Field will eventually move to struct ast_channel.caller.id.tag).
Definition at line 300 of file channel.h.
Referenced by ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), callerid_read(), callerid_write(), cb_events(), dahdi_new(), free_cid(), misdn_call(), and sip_new().
| int cid_tns |
Callerid Transit Network Select.
- Note:
- Currently this value is just passed around the system. You can read it and set it but it is never used for anything. (Field will eventually move to struct ast_channel.dialed.transit_network_select)
Definition at line 290 of file channel.h.
Referenced by ast_iax2_new(), ast_str_retrieve_variable(), ast_var_channels_table(), begin_dial_channel(), dial_exec_full(), do_forward(), iax2_call(), local_call(), ring_entry(), setup_env(), and wait_for_answer().
| int cid_ton |
Callerid Q.931 encoded type-of-number/numbering-plan fields.
- Note:
- Currently this value is mostly just passed around the system. The H.323 interfaces set the value from received messages and uses the value for sent messages. The DAHDI PRI interfaces set the value from received messages but does not use it for sent messages. You can read it and set it but only H.323 uses it. (Field will eventually move to struct ast_channel.caller.id.number_type)
Definition at line 282 of file channel.h.
Referenced by __oh323_new(), ast_channel_data_add_structure(), ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_iax2_new(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), ast_str_retrieve_variable(), ast_var_channels_table(), callerid_read(), callerid_write(), cb_events(), dahdi_new(), and setup_env().
struct ast_party_subaddress dialed_subaddress [read] |
Dialed/Called subaddress. (Field will eventually move to struct ast_channel.dialed.subaddress).
Definition at line 311 of file channel.h.
Referenced by callerid_read(), callerid_write(), free_cid(), and set_one_cid().
struct ast_party_subaddress subaddress [read] |
Caller id subaddress. (Field will eventually move to struct ast_channel.caller.id.subaddress).
Definition at line 306 of file channel.h.
Referenced by ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_party_caller_copy(), ast_party_connected_line_collect_caller(), callerid_read(), callerid_write(), free_cid(), and set_one_cid().
The documentation for this struct was generated from the following file:
