forked from telstra/MessagingAPI-SDK-node
/
package.json
21 lines (21 loc) · 9.71 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"name": "Telstra_Messaging",
"version": "1.0.6",
"description": "_Introductiontabletbodytrtd_class__into_api_stylebordernonepadding0_0_0_0pSend_and_receive_SMS_and_MMS_messages_globally_using_Telstras_enterprise_grade_Messaging_API__It_also_allows_your_application_to_track_the_delivery_status_of_both_sent_and_received_messages__Get_your_dedicated_Australian_number_and_start_sending_and_receiving_messages_today_ptdtd_class__into_api_logo_stylewidth_20bordernoneimg_class__api_logo_stylemargin__26px_0_0_0_src__httpstest_telstra_retail_tdev_devportal_apigee_iositesdefaultfilesmessagingapi_icon_pngtdtrtbodytable_FeaturesThe_Telstra_Messaging_API_provides_the_features_below___Feature___Description_________________Dedicated_Number___Provision_a_mobile_number_for_your_account_to_be_used_as_from_address_in_the_API____Send_Messages___Sending_SMS_or_MMS_messages____Receive_Messages___Telstra_will_deliver_messages_sent_to_a_dedicated_number_or_to_the_notifyURL_defined_by_you____Broadcast_Messages___Invoke_a_single_API_call_to_send_a_message_to_a_list_of_numbers_provided_in_to____Delivery_Status___Query_the_delivery_status_of_your_messages____Callbacks___Provide_a_notification_URL_and_Telstra_will_notify_your_app_when_a_message_status_changes____Alphanumeric_Identifier___Differentiate_yourself_by_providing_an_alphanumeric_string_in_from__This_feature_is_only_available_on_paid_plans____Concatenation___Send_messages_up_to_1900_characters_long_and_Telstra_will_automaticaly_segment_and_reassemble_them____Reply_Request___Create_a_chat_session_by_associating_messageId_and_to_number_to_track_responses_received_from_a_mobile_number__We_will_store_this_association_for_8_days____Character_set___Accepts_all_Unicode_characters_as_part_of_UTF_8____Bounce_back_response___See_if_your_SMS_hits_an_unreachable_or_unallocated_number__Australia_Only____Queuing___Messaging_API_will_automatically_queue_and_deliver_each_message_at_a_compliant_rate_____Emoji_Encoding___The_API_supports_the_encoding_of_the_full_range_of_emojis__Emojis_in_the_reply_messages_will_be_in_their_UTF_8_format____Delivery_Notification_or_CallbacksThe_API_provides_several_methods_for_notifying_when_a_message_has_been_delivered_to_the_destination_1__When_you_send_a_message_there_is_an_opportunity_to_specify_a_notifyURL__Once_the_message_has_been_delivered_the_API_will_make_a_call_to_this_URL_to_advise_of_the_message_status_2__If_you_do_not_specify_a_URL_you_can_always_call_the_GET_status_API_to_get_the_status_of_the_message__Getting_Access_to_the_API1__Register_at__httpsdev_telstra_com_httpsdev_telstra_com_2__After_registration_login_to__httpsdev_telstra_com_httpsdev_telstra_com_and_navigate_to_the_My_apps_page_3__Create_your_application_by_clicking_the_Add_new_app_button4__Select_API_Free_Trial_Product_when_configuring_your_application__This_Product_includes_the_Telstra_Messaging_API_as_well_as_other_free_trial_APIs__Your_application_will_be_approved_automatically_5__There_is_a_maximum_of_1000_free_messages_per_developer__Additional_messages_and_features_can_be_purchased_from__httpsdev_telstra_com_httpsdev_telstra_com_6__Note_your_Client_key_and_Client_secret_as_these_will_be_needed_to_provision_a_number_for_your_application_and_for_authentication_Now_head_over_to_Getting_Started_where_you_can_find_a_postman_collection_as_well_as_some_links_to_sample_apps_and_SDKs_to_get_you_started_Happy_Messaging_Frequently_Asked_QuestionsQ_Is_creating_a_subscription_via_the_Provisioning_call_a_required_stepA__Yes__You_will_only_be_able_to_start_sending_messages_if_you_have_a_provisioned_dedicated_number__Use_Provisioning_to_create_a_dedicated_number_subscription_or_renew_your_dedicated_number_if_it_has_expired_Q_When_trying_to_send_an_SMS_I_receive_a_400_Bad_Request_response__How_can_I_fix_thisA__You_need_to_make_sure_you_have_a_provisioned_dedicated_number_before_you_can_send_an_SMS__If_you_do_not_have_a_provisioned_dedicated_number_and_you_try_to_send_a_message_via_the_API_you_will_get_the_error_below_in_the_responseprecode_classlanguage_sh__status400__codeDELIVERY_IMPOSSIBLE__messageInvalid_from_address_specifiedcodepreUse_Provisioning_to_create_a_dedicated_number_subscription_or_renew_your_dedicated_number_if_it_has_expired_Q_How_long_does_my_dedicated_number_stay_active_forA__When_you_provision_a_dedicated_number_by_default_it_will_be_active_for_30_days__You_can_use_the_activeDays_parameter_during_the_provisioning_call_to_increment_or_decrement_the_number_of_days_your_dedicated_number_will_remain_active_Note_that_Free_Trial_apps_will_have_30_days_as_the_maximum_activeDays_they_can_add_to_their_provisioned_number__If_the_Provisioning_call_is_made_several_times_within_that_30_Day_period_it_will_return_the_expiryDate_in_the_Unix_format_and_will_not_add_any_activeDays_until_after_that_expiryDate_Q_Can_I_send_a_broadcast_message_using_the_Telstra_Messaging_APIA__Yes__Recipient_numbers_can_be_in_the_form_of_an_array_of_strings_if_a_broadcast_message_needs_to_be_sent_allowing_you_to_send_to_multiple_mobile_numbers_in_one_API_call___A_sample_request_body_for_this_will_be_to_6141234567861487654321bodyTest_Message__Q_Can_I_send_SMS_and_MMS_to_all_countriesA__You_can_send_SMS_and_MMS_to_all_countries_EXCEPT_to_countries_which_are_subject_to_global_sanctions_namely_Burma_Cte_dIvoire_Cuba_Iran_North_Korea_Syria_Q_Can_I_use_Alphanumeric_Identifier_from_my_paid_plan_via_credit_cardA__Alphanumeric_Identifier_is_only_available_on_Telstra_Account_paid_plans_not_through_credit_card_paid_plans_Q_What_is_the_maximum_sized_MMS_that_I_can_sendA__This_will_depend_on_the_carrier_that_will_receive_the_MMS__For_Telstra_its_up_to_2MB__Optus_up_to_1_5MB_and_Vodafone_only_allows_up_to_500kB__You_will_need_to_check_with_international_carriers_for_thier_MMS_size_limits_Q_How_is_the_size_of_an_MMS_calculatedA__Images_are_scaled_up_to_approximately_43_when_base64_encoded_Additionally_there_is_approximately_200_bytes_of_overhead_on_each_MMS_Assuming_the_maximum_MMS_that_can_be_sent_on_Telstras_network_is_2MB_then_the_maximum_image_size_that_can_be_sent_will_be_approximately_1_378MB__1_378_x_1_34__200_without_SOAP_encapsulation_Q_How_is_an_MMS_classified_as_Small_or_LargeA__MMSes_with_size_below_600kB_are_classed_as_Small_whereas_those_that_are_bigger_than_600kB_are_classed_as_Large__They_will_be_charged_accordingly_Q_Are_SMILs_supported_by_the_Messaging_APIA__While_there_will_be_no_error_if_you_send_an_MMS_with_a_SMIL_presentation_the_actual_layout_or_sequence_defined_in_the_SMIL_may_not_display_as_expected_because_most_of_the_new_smartphone_devices_ignore_the_SMIL_presentation_layer__SMIL_was_used_in_feature_phones_which_had_limited_capability_and_SMIL_allowed_a_powerpoint_type_presentation_to_be_provided__Smartphones_now_have_the_capability_to_display_video_which_is_the_better_option_for_presentations__It_is_recommended_that_MMS_messages_should_just_drop_the_SMIL_Q_How_do_I_assign_a_delivery_notification_or_callback_URLA__You_can_assign_a_delivery_notification_or_callback_URL_by_adding_the_notifyURL_parameter_in_the_body_of_the_request_when_you_send_a_message__Once_the_message_has_been_delivered_a_notification_will_then_be_posted_to_this_callback_URL_Q_What_is_the_difference_between_the_notifyURL_parameter_in_the_Provisoning_call_versus_the_notifyURL_parameter_in_the_Send_Message_callA__The_notifyURL_in_the_Provisoning_call_will_be_the_URL_where_replies_to_the_provisioned_number_will_be_posted_On_the_other_hand_the_notifyURL_in_the_Send_Message_call_will_be_the_URL_where_the_delivery_notification_will_be_posted_e_g__when_an_SMS_has_already_been_delivered_to_the_recipient__Getting_StartedBelow_are_the_steps_to_get_started_with_the_Telstra_Messaging_API___1__Generate_an_OAuth2_token_using_your_Client_key_and_Client_secret___2__Use_the_Provisioning_call_to_create_a_subscription_and_receive_a_dedicated_number___3__Send_a_message_to_a_specific_mobile_number__Run_in_Postmanahrefhttpsapp_getpostman_comrun_collectionded00578f69a9deba256env5BMessaging20API20Environments5DW3siZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X2lkIiwidmFsdWUiOiIiLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiY2xpZW50X3NlY3JldCIsInZhbHVlIjoiIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6Imhvc3QiLCJ2YWx1ZSI6InRhcGkudGVsc3RyYS5jb20iLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoiQXV0aG9yaXphdGlvbiIsInZhbHVlIjoiIiwidHlwZSI6InRleHQifSx7ImVuYWJsZWQiOnRydWUsImtleSI6Im9hdXRoX2hvc3QiLCJ2YWx1ZSI6InNhcGkudGVsc3RyYS5jb20iLCJ0eXBlIjoidGV4dCJ9LHsiZW5hYmxlZCI6dHJ1ZSwia2V5IjoibWVzc2FnZV9pZCIsInZhbHVlIjoiIiwidHlwZSI6InRleHQifV0imgsrchttpsrun_pstmn_iobutton_svg_altRun_in_Postmana_Sample_Apps_____Perl_Sample_App_httpsgithub_comtelstraMessagingAPI_perl_sample_app_____Happy_Chat_App_httpsgithub_comtelstramessaging_sample_code_happy_chat_____PHP_Sample_App_httpsgithub_comdeveloperstevetelstra_messaging_php_SDK_Repos_____Messaging_API___PHP_SDK_httpsgithub_comtelstraMessagingAPI_SDK_php_____Messaging_API___Python_SDK_httpsgithub_comtelstraMessagingAPI_SDK_python_____Messaging_API___Ruby_SDK_httpsgithub_comtelstraMessagingAPI_SDK_ruby_____Messaging_API___NodeJS_SDK_httpsgithub_comtelstraMessagingAPI_SDK_node_____Messaging_API____Net2_SDK_httpsgithub_comtelstraMessagingAPI_SDK_dotnet_____Messaging_API___Java_SDK_httpsgithub_comtelstraMessagingAPI_SDK_Java_Blog_PostsFor_more_information_on_the_Messaging_API_you_can_read_these_blog_posts___Callbacks_Part_1_httpsdev_telstra_comcontentunderstanding_messaging_api_callbacks_part_1____Callbacks_Part_2_httpsdev_telstra_comcontentunderstanding_messaging_api_callbacks_part_2",
"license": "MIT",
"main": "src/index.js",
"scripts": {
"test": "./node_modules/mocha/bin/mocha --recursive"
},
"browser": {
"fs": false
},
"dependencies": {
"superagent": "3.7.0"
},
"devDependencies": {
"mocha": "~2.3.4",
"sinon": "1.17.3",
"expect.js": "~0.3.1"
}
}